Skip to content

docs: add developer glossary to getting_started section#15013

Open
miaulalala wants to merge 1 commit into
masterfrom
feature/developer-glossary
Open

docs: add developer glossary to getting_started section#15013
miaulalala wants to merge 1 commit into
masterfrom
feature/developer-glossary

Conversation

@miaulalala
Copy link
Copy Markdown
Contributor

☑️ Resolves

No linked issue — this is a new page ported from the Nextcloud dev course tutorial materials.

📝 Summary

Adds a developer glossary at developer_manual/getting_started/glossary.rst, placed as the first entry in the Getting Started toctree so new contributors see it before the dev environment and coding standards pages.

The source was tutorials/nextcloud-dev-course/before-you-start.md, a concepts reference written for an introductory dev course. Changes from the source:

  • Full RST conversion: .. code-block::, .. list-table::, :command: roles, local .. contents:: TOC
  • Added .. _csrf: and .. _ocs-api: anchors for cross-referencing from other pages
  • Fixed a cross-manual reference that does not resolve inside the developer manual build (replaced with external URL)
  • Expanded several entries for clarity and consistency with existing docs tone
  • Build passes with no warnings; sphinx-lint reports no problems

🖼️ Screenshots

No visual/layout changes — new content page only.

✅ 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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 26, 2026

📖 Documentation Preview

🔍 Open preview →

📄 2 changed documentation pages

Last updated: Tue, 26 May 2026 20:22:08 GMT

Converts the concepts glossary from tutorials/nextcloud-dev-course/ into
a properly formatted RST page at developer_manual/getting_started/glossary.rst.
Adds it as the first entry in the getting_started toctree so new contributors
find it before diving into environment setup.

Improvements over the source document:
- Full RST conversion: code-block directives, list-table, :command: roles
- Added .. contents:: local TOC for easy navigation
- Added .. _csrf: and .. _ocs-api: anchors for cross-referencing
- Replaced broken cross-manual :doc: ref with an external URL
- Expanded several entries for clarity and consistency with docs style
- Removed tutorial-specific environment instructions where not appropriate

AI-Assisted-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Anna Larch <anna@nextcloud.com>
@miaulalala miaulalala force-pushed the feature/developer-glossary branch from ab497b6 to 9f39759 Compare May 26, 2026 20:13
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.

1 participant