Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Add a glossary #28

Open
3 tasks
curtisma opened this issue Aug 20, 2022 · 2 comments
Open
3 tasks

Add a glossary #28

curtisma opened this issue Aug 20, 2022 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@curtisma
Copy link
Contributor

curtisma commented Aug 20, 2022

Problem Statement

There's some terminology that may be confusing to new users and it needs to be easy to find the definition of it.

Proposed Solution

Add a glossary to the documentation defining key terms that may need explanation. especially to those not familiar with Cadence or SKILL. Here are some initial terms we should include, but feel free to propose others:

  • Disembodied property list (DPL)
  • .cdsinit file
  • cdsLibMgr.il file
  • data.reg file

Follow the docs of the Sphinx theme we're using to implement it in a new documentation page added to the end of the overview TOC.

https://pydata-sphinx-theme.readthedocs.io/en/stable/demo/kitchen-sink/paragraph-markup.html?highlight=glossary#glossary


Glossary
--------

This is a glossary with definition terms for things like :term:`Writing`:

.. glossary::

  Documentation
     Provides users with the knowledge they need to use something.

  Reading
     The process of taking information into ones mind through the use of eyes.

  Writing
     The process of putting thoughts into a medium for other people to :term:`read <Reading>`.

Alternatives Considered

Proposed Action Plan

  • 1. we'll do this
  • 2. We'll do that
  • 3. Then we'll add tests for this and that.
@curtisma curtisma added enhancement New feature or request good first issue Good for newcomers labels Aug 20, 2022
@basic5253
Copy link

Do you mind elaborating on the project?

@curtisma
Copy link
Contributor Author

Do you mind elaborating on the project?

I added some additional details to the issue. Let me know if you have any specific questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants