Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Fix documentation formatting #17121

Merged
merged 2 commits into from
Sep 12, 2024
Merged

Fix documentation formatting #17121

merged 2 commits into from
Sep 12, 2024

Conversation

CyrilleB79
Copy link
Collaborator

@CyrilleB79 CyrilleB79 commented Sep 5, 2024 •
edited
Loading

Closing tag issue found while reviewing ja user guide following @nishimotz's message on the translators mailing list.

Link to issue number:

Fixes #17159

Summary of the issue:

Commands Quick Reference includes text that was not intended to be included, due to missing closing tag <!-- KC:endInclude -->

Description of user facing changes

The Commands Quick Reference will no longer include text unrelated to shortcut keys.

Description of development approach

Added the closing tag in the User Guide.

Testing strategy:

Check the newly generated Commands Quick Reference.

Known issues with pull request:

None

Code Review Checklist:

  • Documentation:
    • Change log entry
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • API is compatible with existing add-ons.
  • Security precautions taken.

Summary by CodeRabbit

  • Documentation
    • Updated the user guide to improve structural organization with a new comment tag for better section management.

@CyrilleB79 CyrilleB79 marked this pull request as ready for review September 5, 2024 21:41
@CyrilleB79 CyrilleB79 requested a review from a team as a code owner September 5, 2024 21:41
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 5, 2024 •
edited
Loading

Walkthrough

The documentation in the user_docs/en/userGuide.md file has been updated to include a comment tag <!-- KC:endInclude --> before the section header for "Papenmeier BRAILLEX Newer Models." This change is a structural update intended to enhance organization within the document without affecting any functionality or logic.

Changes

Files Change Summary
user_docs/en/userGuide.md Added comment tag <!-- KC:endInclude --> before "Papenmeier BRAILLEX Newer Models" section header.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@CyrilleB79 CyrilleB79 marked this pull request as draft September 5, 2024 21:44
@CyrilleB79
Copy link
Collaborator Author

Strangely, the issue in the key commands document is not fixed (on appVeyor artifacts).

@seanbudd
Copy link
Member

@CyrilleB79 - could you open an issue to explain the problem being faced more thoroughly?

@CyrilleB79 CyrilleB79 marked this pull request as ready for review September 11, 2024 08:13
@CyrilleB79
Copy link
Collaborator Author

@seanbudd this PR is now ready.

I have opened #17159 to describe the issue with more details.

After merging last beta, the issue described in #17121 (comment) is not present anymore; I do not know why.

In the meantime, the translation freeze period has started. Since it is quite long (more than usual), I wonder if you would still accept this PR against beta. If not, let me know and I'll rebase on master.

@CyrilleB79
Copy link
Collaborator Author

Please note that this change should have no impact for translators using the new framework to translate the user guide through Crowdin.

For translators still using the old framework (SVN), it would have an impact, but I guess that new changes won't be merged anymore in SVN. So no problem.

@michaelDCurran michaelDCurran merged commit 7d3b33e into nvaccess:beta Sep 12, 2024
5 checks passed
@github-actions github-actions bot added this to the 2025.1 milestone Sep 12, 2024
@CyrilleB79 CyrilleB79 deleted the docFmt branch September 13, 2024 09:23
@SaschaCowley SaschaCowley linked an issue Sep 16, 2024 that may be closed by this pull request
The Commands Quick Reference contains text from the User Guide that should not belong to it #17159
Open
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@michaelDCurran michaelDCurran michaelDCurran approved these changes

@Qchristensen Qchristensen Awaiting requested review from Qchristensen Qchristensen is a code owner automatically assigned from nvaccess/userdocs

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
2025.1
Development

Successfully merging this pull request may close these issues.

The Commands Quick Reference contains text from the User Guide that should not belong to it
3 participants
@CyrilleB79 @seanbudd @michaelDCurran