bec/csaxs_bec
0
0
Fork 1
Code Issues 17 Pull Requests 4 Actions Packages Projects Releases Wiki Activity

docs(developer): add "How to edit these docs" contributor guide #236

Merged
menzel merged 1 commits from docs/editing-guide into main 2026-06-24 18:26:23 +02:00
Conversation 0 Commits 1 Files Changed 2
+174 -1
menzel commented 2026-06-24 18:22:16 +02:00
Member
Copy Link
Copy Source

Add docs/developer/editing_docs.md documenting the MyST/Sphinx conventions
for this site: page anatomy (cross-reference label + single H1), language-
tagged code fences, admonitions, cross-references, the {download} role for
non-image files, the {figure} directive, and how to add a page to a toctree.
Also covers local preview, the merge-then-RTD-build flow, and pitfalls
(broken refs are warnings, public visibility, placeholder consistency).

Turn the empty developer.md stub into a landing page with a toctree and a
card linking to the new guide.

Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com

Add docs/developer/editing_docs.md documenting the MyST/Sphinx conventions for this site: page anatomy (cross-reference label + single H1), language- tagged code fences, admonitions, cross-references, the {download} role for non-image files, the {figure} directive, and how to add a page to a toctree. Also covers local preview, the merge-then-RTD-build flow, and pitfalls (broken refs are warnings, public visibility, placeholder consistency). Turn the empty developer.md stub into a landing page with a toctree and a card linking to the new guide. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
menzel added 1 commit 2026-06-24 18:22:16 +02:00
docs(developer): add "How to edit these docs" contributor guide
CI for csaxs_bec / test (pull_request) Successful in 1m34s
Details
Read the Docs Deploy Trigger / trigger-rtd-webhook (push) Successful in 3s
Details
CI for csaxs_bec / test (push) Successful in 1m35s
Details
ba27af5a71 
Add docs/developer/editing_docs.md documenting the MyST/Sphinx conventions
for this site: page anatomy (cross-reference label + single H1), language-
tagged code fences, admonitions, cross-references, the {download} role for
non-image files, the {figure} directive, and how to add a page to a toctree.
Also covers local preview, the merge-then-RTD-build flow, and pitfalls
(broken refs are warnings, public visibility, placeholder consistency).

Turn the empty developer.md stub into a landing page with a toctree and a
card linking to the new guide.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
menzel merged commit ba27af5a71 into main 2026-06-24 18:26:23 +02:00
menzel deleted branch docs/editing-guide 2026-06-24 18:26:23 +02:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
issue::not confirmed
Used if an issue has not yet been confirmed by a developer
 issue::not reproducible
Used if an issue is not reproducible
 issue::reproducible
Used if a developer was able to reproduce the issue
 priority::critical
Should be done as soon as possible
 priority::needed
An important update to the code base
 priority::nice to have
Not really needed but a good improvement
 scope::backend
An issue regarding the backend services
 scope::frontend
An issue regarding the user-facing services
 stage::in development
This issue is currently being worked on
 stage::on hold
Something is blocking the development
 stage::pre_release
For issues that have been merged into a pre-release branch and are waiting for their release.
stage::ready for review
For issues that have been resolved and are ready for review
 stage::selected for development
This issue has been selected for development but has not been scheduled yet
 stage::weekly backlog
This issue has been selected for development for the next development cycle
 type::bug
It's a bug!
 type::discussion
A discussion is wanted/needed
 type::doc
Improvements to the documentation
 type::feature
A new feature
 type::improvement
Neither a feature nor a bug but an improvement to the code base
 type::test
Missing tests or improvements to the test suite
bug
Something is not working
 duplicate
This issue or pull request already exists
 enhancement
New feature
 help wanted
Need some help
 invalid
Something is wrong
 question
More information is needed
 wontfix
This won't be fixed
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
acerbo_a (acerbo_a) appel_c (appel_c) bec-gitea celcer_t (celcer_t) debenjak_l (debenjak_l) diaz (diaz) divall_e (divall_e) guizar_m (guizar_m) haghta_s (haghta_s) holler (holler) lombosi_c (lombosi_c) menzel (menzel) perl_d (perl_d) usov_i (usov_i) wakonig_k (wakonig_k) wang_x1 (wang_x1) wyzula_j (wyzula_j) zamofing_t (zamofing_t)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: bec/csaxs_bec#236
Delete Branch "docs/editing-guide"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?