Skip to content

Update user manual reference documentation#9434

Draft
javimed wants to merge 3 commits intomainfrom
enhancement/idr663-update-user-manual-reference-section
Draft

Update user manual reference documentation#9434
javimed wants to merge 3 commits intomainfrom
enhancement/idr663-update-user-manual-reference-section

Conversation

@javimed
Copy link
Copy Markdown
Member

@javimed javimed commented Mar 26, 2026

Description

This PR updates the Reference guide in the user manual documentation

Documentation compilation

  • Verify that documentation compiles without warnings.

Changelog

  • Update CHANGELOG.md.

Web optimization & code formatting

  • Page references
    • Update /_static/js/redirects.js if necessary (guide).
    • Update /llms.txt if necessary.
  • Add or update meta descriptions.
  • Use three-space indentation in .rst files.

Writing style

  • Use bold for UI elements, italics for key terms and emphasis, and code font for Bash commands, file names, REST paths, and code.
  • Follow present tense, active voice, and a semi-formal tone.
  • Write short, clear, and concise sentences.

@javimed javimed changed the title {WiP} Update user manual reference documentation Update user manual reference documentation Mar 27, 2026
@javimed javimed self-assigned this Mar 27, 2026
@javimed javimed marked this pull request as ready for review March 27, 2026 11:55
@javimed javimed requested a review from ayodeko March 27, 2026 11:55
@javimed javimed marked this pull request as draft March 27, 2026 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant