Skip to content

docs(user_manual): cleanup prose and RST style in access_webdav.rst#14869

Open
Copilot wants to merge 6 commits into
masterfrom
copilot/update-access-webdav-docs
Open

docs(user_manual): cleanup prose and RST style in access_webdav.rst#14869
Copilot wants to merge 6 commits into
masterfrom
copilot/update-access-webdav-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 16, 2026

☑️ Resolves

Small docs-only cleanup pass for user_manual/files/access_webdav.rst to improve prose, grammar, and style-guide alignment without changing documented behavior.

  • Scope

    • Limited to user_manual/files/access_webdav.rst only.
  • Prose and style cleanup

    • Reworded several sentences for clearer second-person, active-voice phrasing.
    • Fixed awkward grammar/wording and normalized capitalization (for example, “Web interface”, “Web browser”).
    • Tightened step wording and removed ambiguous phrasing.
  • RST consistency

    • Corrected heading underline length for the WinSCP subsection.
    • Aligned list marker usage with surrounding auto-numbered list style.
  • Representative edit

    -5. Click the ``Finish`` button.
    +#. Click the ``Finish`` button.

🖼️ Screenshots

✅ Checklist

  • I have built the documentation locally and reviewed the output
  • Screenshots are included for visual changes
  • I have not moved or renamed pages (or added a redirect if I did)
  • I have run codespell or similar and addressed any spelling issues
Original prompt

Create a small documentation-only pull request in nextcloud/documentation that performs a prose, syntax, and style-guide cleanup pass on this remaining file in user_manual/files:

  • user_manual/files/access_webdav.rst

Follow the repository style guide in style_guide.rst, especially:

  • use sentence case in headings
  • write in second person and active voice where practical
  • keep wording literal and specific
  • prefer clear, concise phrasing
  • keep line wrapping around 120 characters where practical
  • preserve blank lines after directives
  • do not add trailing spaces
  • maintain valid reStructuredText/Sphinx markup
  • preserve existing meaning; do not introduce technical behavior changes

Scope constraints:

  • Keep this manageable and focused. This should be a small docs pass, not a large rewrite.
  • Limit changes to the file above only.
  • Do not modify index files, build/config files, templates, or images.
  • Prefer prose/style/syntax fixes: grammar, punctuation, capitalization, awkward phrasing, consistency, alt text quality, list wording, and obvious style-guide issues.
  • Avoid unnecessary restructuring.

Please create a PR with a concise summary of the style/prose cleanup.

The following is the prior conversation context from the user's chat exploration (may be truncated):

Assistant: Yes — the root user_manual files are a very sensible scope.

That’s probably the safest “reasonable-sized” pass because it gives you:

  • a small, bounded set
  • mostly pure prose/how-to content
  • good chances for style-guide consistency
  • less risk of wandering into sprawling subtrees

The obvious set is:

  • user_manual/activity.rst
  • user_manual/session_management.rst
  • user_manual/universal_access.rst
  • user_manual/user_2fa.rst
  • user_manual/userpreferences.rst
  • user_manual/webinterface.rst

I’d treat those as a nice compact batch and leave out:

  • index.rst
  • contents.rst
  • build/config files
  • templates
  • subdirectories like desktop/, files/, groupware/, talk/

Why this is a good target:

  • all in one place
  • similar doc type
  • limited file count
  • likely enough text to make progress without turning into a monster PR

If you want to keep it even tighter, I’d start with just 3–4 files:

  • activity.rst
  • session_management.rst
  • user_2fa.rst
  • userpreferences.rst

That feels very PR-friendly.

If you want, I can now:

  1. quickly check those root files against the style guide, and
  2. suggest the exact subset that looks best for this pass.

User: A bit more that 3 files. How many are in the root ?

Assistant: There are 8 prose/content .rst files at the root of user_manual if you exclude the index/navigation/build files:

  • activity.rst
  • session_management.rst
  • universal_access.rst
  • user_2fa.rst
  • userpreferences.rst
  • webinterface.rst

Actually, from what I can see, that list is 6 root content files.

Other root .rst files there are structural rather than prose-pass targets:

  • contents.rst
  • index.rst

So the root breaks down like this:

  • 6 good prose-pass candidates
  • 2 structural/index files
  • plus non-doc/build/template items

If you want “a bit more than 3 files,” then doing all 6 root content files seems like a very reasonable scope.

User: Let's do them

Assistant: Sounds good — all 6 root content files in user_manual is a solid, manageable pass.

That scope is:

  • user_manual/activity.rst
  • user_manual/session_management.rst
  • user_manual/universal_access.rst
  • user_manual/user_2fa.rst
  • user_manual/userpreferences.rst
  • user_manual/webinterface.rst

If you want me to open a PR for that pass, say so and I can do it.

If you want, I can also help first by:

  • skimming those files for likely style-guide issues, and
  • drafting a concise PR scope/commit plan before opening it.

User: Implement this

Assistant: I’ve started the PR creation flow for that focused docs pass and we’re currently waiting for your response to the confirmation dialog to continue.

Assistant: I’ve started creating the pull request for prose, syntax, and style-guide improvements to the six root user_manual pages.

You can track the progress of the task directly. Once completed, I’ll let you know and provide the details of the pull request.

User: Now files, let's see how that would work

Assistant: For a similarly manageable pass, user_manual/files/ could work well — but I’d still want to keep it narrowed.

My suggestion would be to do it in one slice of that folder, not the entire subtree at once.

Good options:

  • a small cluster of introductory/how-to pages
  • or just the root .rst files directly under user_manual/files/, excluding deeper subfolders if there are many

That keeps the pattern consistent with what we just did:

  • bounded scope
  • user-facing prose
  • lower risk of a giant PR

If you want, I can inspect user_manual/files/ and suggest:

  1. the full file count
  2. a *small/medium reasonable subset...

This pull request was created from Copilot chat.

Copilot AI and others added 5 commits May 16, 2026 04:42
Agent-Logs-Url: https://github.com/nextcloud/documentation/sessions/2c1f4cf0-01aa-4de3-94e3-2d687cf5d98a

Co-authored-by: skjnldsv <14975046+skjnldsv@users.noreply.github.com>
This reverts commit 4004be2.

Co-authored-by: skjnldsv <14975046+skjnldsv@users.noreply.github.com>
Agent-Logs-Url: https://github.com/nextcloud/documentation/sessions/2c1f4cf0-01aa-4de3-94e3-2d687cf5d98a

Co-authored-by: skjnldsv <14975046+skjnldsv@users.noreply.github.com>
Copilot AI changed the title [WIP] Cleanup prose and style in access_webdav.rst docs(user_manual): cleanup prose and RST style in access_webdav.rst May 16, 2026
Copilot AI requested a review from skjnldsv May 16, 2026 04:49
@skjnldsv skjnldsv marked this pull request as ready for review May 16, 2026 05:16
@skjnldsv skjnldsv requested review from janepie and miaulalala May 16, 2026 05:16
@skjnldsv skjnldsv enabled auto-merge May 16, 2026 05:16
@github-actions
Copy link
Copy Markdown
Contributor

📖 Documentation Preview

🔍 Open preview →

📄 1 changed documentation page

Last updated: Sat, 16 May 2026 05:21:45 GMT

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants