Skip to content

Add a glossary #28

Open
Open
@curtisma

Description

@curtisma

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions