Skip to content

Docs: small wording and link consistency fixes#14716

Open
Copilot wants to merge 2 commits intocopilot/analyze-current-workflow-netlifyfrom
copilot/docs-improvement-for-netlify-preview
Open

Docs: small wording and link consistency fixes#14716
Copilot wants to merge 2 commits intocopilot/analyze-current-workflow-netlifyfrom
copilot/docs-improvement-for-netlify-preview

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 3, 2026

Small prose-quality pass across five user/admin manual pages. No structural changes — all edits are grammar, word choice, line-length, and link-text fixes.
This is for a quick and easy example on how the netlify PR works for PRs that actually change some content
#14715

Changes

  • user_manual/webinterface.rst — Fix malformed RST hyperlink (period was inside the backtick, making it part of the link text); migrate tonavigate to for breadcrumb description
  • user_manual/user_2fa.rst — Add blank line after section heading for consistency; device specificdevice-specific; login (noun) → log in (verb); fix punctuation in Considerations
  • user_manual/userpreferences.rstsettings depending onsettings depend on; and guestand guests; Which allows to configurewhich allows you to configure
  • admin_manual/index.rst — Wrap two prose lines (174 and 348 chars) to the repo's 120-char limit
  • user_manual/session_management.rst — Word-order fix (have only accessonly have access); henceso; reword dangling-then sentence for clarity

☑️ Resolves

No linked issue — intended to validate Netlify preview deployments.

🖼️ Screenshots

Prose-only edits; no visual layout changes.

✅ 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 docs-only pull request in nextcloud/documentation suitable for testing Netlify preview deployments.

Scope/constraints:

  • Docs-only changes (no code changes).
  • Keep it small: ~30–40 changed lines total, across ~4–5 files.
  • Focus on “nice refactor/improvement” via prose/clarity/consistency and minor formatting/link improvements.
  • Avoid large rewrites; prefer low-risk edits that are easy to review.

Suggested types of edits (choose appropriate ones based on existing content and conventions in the repo):

  • Fix minor grammar/typos and improve sentence clarity.
  • Standardize terminology/capitalization to match surrounding docs conventions.
  • Improve link text (avoid “here”), convert raw URLs to proper links where appropriate.
  • Add 1–2 small cross-links (“See also”) where helpful.
  • Minor markup cleanup (list indentation, backticks around UI labels, consistent code block formatting) if relevant.

Implementation guidance:

  • Identify 4–5 documentation files that benefit from small touch-ups.
  • Make small targeted edits in each file (roughly 5–10 lines per file).
  • Ensure formatting renders correctly (Markdown or reStructuredText depending on file types).
  • Run/ensure any doc checks that exist in CI are satisfied.

Deliverable:

  • Open a PR with a concise title like “Docs: small wording and link consistency fixes”.
  • In the PR description, summarize changes per file and mention it’s intended to validate Netlify preview.

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

User: I would like to try a pull request that changes some content to try the Netlify preview PR that I opened. Find me some nice refactor/improvement that you can do or prose improvement on the docs. Nothing too big, just enough for a tiny pr like 30/40 changed lines across 4/5 changed files

Assistant: I’m waiting for your confirmation in the approval dialog to proceed with creating that small docs-only pull request in nextcloud/documentation.

Assistant: Let me know if you'd like me to retry creating the small documentation PR for nextcloud/documentation.

User: Just tell me what you suggest to do before creating an agent

Assistant: Here are a few “tiny PR” ideas (30–40 lines total, spread across ~4–5 files) that are safe, useful, and easy to review—good for validating a Netlify preview without risking behavior changes.

Option A (my top pick): “Docs polish sweep” (low risk, very reviewable)

Do small, consistent prose and formatting fixes across a handful of docs pages:

  • Fix a few grammar issues / awkward sentences
  • Standardize capitalization (e.g., “Nextcloud server” vs “Nextcloud Server” if the docs have a convention)
  • Replace “e.g.” / “i.e.” inconsistencies, add commas for readability
  • Convert a couple of raw URLs into proper links
  • Ensure headings use consistent style (sentence case vs title case—match repo convention)
  • Fix tiny markup issues (extra spaces in code blocks, inconsistent backticks around UI labels, etc.)

Why it’s good: minimal risk, easy to keep to ~5 files, and Netlify preview clearly shows the diffs.

Option B: “Cross-link and navigation micro-improvements”

Pick 4–5 pages that mention related concepts but don’t link to each other:

  • Add 1–2 “See also” links per page (or inline links)
  • Add an anchor link where a section is referenced elsewhere
  • Improve a couple of link texts from “here” to descriptive labels

Why it’s good: still tiny, but noticeably improves usability.

Option C: “Consistency pass on terminology / UI labels”

Find repeated terms that vary slightly and standardize them across a few pages, for example:

  • “admin” vs “administrator”
  • “log in” (verb) vs “login” (noun)
  • “setup” vs “set up”
  • “web UI” vs “Web interface”
  • consistent formatting for menu paths like Settings → Administration → Logging

Why it’s good: small but meaningful “refactor” of language.

Option D: “Sphinx/ReST / Markdown lint-style micro-fixes”

If the repo uses Sphinx/reStructuredText heavily, there are common tiny cleanups:

  • Ensure code blocks use the correct directive (.. code-block::) and language
  • Fix double blank lines, trailing whitespace, inconsistent indentation in lists
  • Fix admonition formatting (.. note::, .. warning::) or punctuation in admonition titles

Why it’s good: helps prevent doc build warnings and improves rendering.


Two quick questions so I suggest the best specific change set

  1. Do you want docs-only changes (recommended for a “Netlify preview smoke test”), or are small code refactors okay too?
  2. Do you prefer the PR to touch Markdown, .rst, or “whatever the repo mainly uses”?

If you answer those, I’ll propose a concrete PR plan like:

  • file1: tweak 6 lines (wording + link)
  • file2: tweak 10 lines (formatting)
  • file3: tweak 8 lines (terminology consistency)
  • file4: tweak 7 lines (see-also links)
  • file5: tweak 5 lines (typo fixes)

No agent/PR creation yet—just a c...

This pull request was created from Copilot chat.

Copilot AI changed the title [WIP] Improve documentation clarity and consistency for Netlify preview Docs: small wording and link consistency fixes May 3, 2026
Copilot AI requested a review from skjnldsv May 3, 2026 11:57
@skjnldsv skjnldsv changed the base branch from master to copilot/analyze-current-workflow-netlify May 3, 2026 11:58
@skjnldsv skjnldsv marked this pull request as ready for review May 3, 2026 11:59
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 3, 2026

📖 Documentation Preview

🔍 Open preview →

📄 5 changed documentation pages

Last updated: Sun, 03 May 2026 16:25:33 GMT

@skjnldsv skjnldsv force-pushed the copilot/docs-improvement-for-netlify-preview branch from c2ea325 to dd5dd69 Compare May 3, 2026 14:26
@skjnldsv skjnldsv force-pushed the copilot/analyze-current-workflow-netlify branch from 0bc00cb to 554fbed Compare May 3, 2026 15:38
@skjnldsv skjnldsv force-pushed the copilot/docs-improvement-for-netlify-preview branch from dd5dd69 to d136c0e Compare May 3, 2026 15:42
@skjnldsv skjnldsv force-pushed the copilot/analyze-current-workflow-netlify branch from d2b9461 to 40f57e9 Compare May 3, 2026 16:05
@skjnldsv skjnldsv force-pushed the copilot/docs-improvement-for-netlify-preview branch from d136c0e to 5581535 Compare May 3, 2026 16:11
@github-actions github-actions Bot added the github_actions Pull requests that update GitHub Actions code label May 3, 2026
@skjnldsv skjnldsv requested a review from miaulalala May 3, 2026 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3. to review github_actions Pull requests that update GitHub Actions code manual: admin manual: user

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants