Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ _build/
.idea/
.vscode/
__pycache__
ros2doc/
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ To check the spelling, use:
`make spellcheck`

> [!NOTE]
> If that detects specific words that need to be ignored, add it to [codespell_whitelist](./codespell_whitelist.txt).
> If that detects specific words that need to be ignored, add it to [codespell_whitelist](./codespell_whitelist.txt). \
> To include any custom corrections that are to be applied, add it to [codespell_dictionary](./codespell_dictionary.txt).

### Deployment test

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ You can run the documentation spell checker locally (using `codespell <https://g

If that detects specific words that need to be ignored, add it to `codespell_whitelist <https://github.com/ros2/ros2_documentation/blob/{REPOS_FILE_BRANCH}/codespell_whitelist.txt>`_ .

To know more about spelling checks, refer to :ref:`Spelling check <spelling-check>`

View Site Through Github CI
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -167,6 +168,34 @@ To check for broken links on the site, run:

This will check the entire site for broken links, and output the results to the screen and ``build/linkcheck``.

.. _spelling-check:

Spelling check
^^^^^^^^^^^^^^

The ``make spellcheck`` command scans the documentation files and flags any misspellings.
If errors are detected, review the suggestions and update the pull request as necessary.

Some words, such as technical terms or proper nouns, maybe mistakenly flagged as misspelled.
If you encounter such instances, you can add them to the ignore list to prevent them from being flagged in the future.
To do this, add it to the `codespell_whitelist <https://github.com/ros2/ros2_documentation/blob/{REPOS_FILE_BRANCH}/codespell_whitelist.txt>`_ file as follows:

.. code-block:: text

empy
ws
lets
jupyter

To include custom corrections that ``codespell`` should apply, you can add them to the `codespell_dictionary <https://github.com/ros2/ros2_documentation/blob/{REPOS_FILE_BRANCH}/codespell_dictionary.txt>`_ file as follows:

.. code-block:: text

amnet->ament
colcn->colcon
rosabg->rosbag
rosdistroy->rosdistro

Migrating Pages from the ROS Wiki
---------------------------------

Expand Down