Skip to content
This repository has been archived by the owner on Jun 14, 2024. It is now read-only.

docs: Create glossary for units #93

Closed
3 tasks
uwcdc opened this issue Mar 6, 2024 · 0 comments · Fixed by #92
Closed
3 tasks

docs: Create glossary for units #93

uwcdc opened this issue Mar 6, 2024 · 0 comments · Fixed by #92
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@uwcdc
Copy link
Member

uwcdc commented Mar 6, 2024

Description:

We need to create a glossary for units to provide a reference for common units used throughout our project documentation. This glossary will help maintain consistency and clarity in our technical documentation.

Tasks:

  • Create a new file named glossary.rst under the docs/ directory
  • Populate glossary.rst with definitions of common units used in our project
  • Update the _toc.yml file to include the glossary.rst file so that it appears in the table of contents of our JupyterBook instance

Acceptance Criteria:

The glossary.rst file should contain clear and concise definitions for each unit
The glossary.rst file should be formatted according to our documentation standards
The _toc.yml file should be updated to include the glossary.rst file
The glossary should be accessible and visible in the table of contents of our JupyterBook instance

@uwcdc uwcdc added the documentation Improvements or additions to documentation label Mar 6, 2024
@uwcdc uwcdc linked a pull request Mar 6, 2024 that will close this issue
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants