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 minimal glossary #185

Merged
merged 36 commits into from
Mar 30, 2023
Merged

Add minimal glossary #185

merged 36 commits into from
Mar 30, 2023

Conversation

cbkerr
Copy link
Member

@cbkerr cbkerr commented Mar 29, 2023

Description

My goal is to define the terms for signac-core "good enough" to get started to keep this moving.

I think the new hover extension is worth it to allow people to see the definition when hovering.

Motivation and Context

#59

Work continues at https://docs.google.com/document/d/1_merhcK3ohas4IloE616yL7gypMRFcaQLh2oChExC7o

Checklist:

@cbkerr cbkerr requested a review from a team as a code owner March 29, 2023 03:59
@cbkerr cbkerr requested review from a team as code owners March 29, 2023 03:59
@cbkerr cbkerr requested review from bdice and jennyfothergill and removed request for a team March 29, 2023 03:59
@cbkerr cbkerr changed the base branch from master to feat/signac_2 March 29, 2023 04:00
Copy link
Member

@b-butler b-butler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this meant to cover all uses of the glossary terms?

docs/source/glossary.rst Outdated Show resolved Hide resolved
docs/source/glossary.rst Outdated Show resolved Hide resolved
docs/source/glossary.rst Outdated Show resolved Hide resolved
docs/source/glossary.rst Outdated Show resolved Hide resolved
docs/source/jobs.rst Outdated Show resolved Hide resolved
@b-butler
Copy link
Member

@cbkerr you need to ensure that the readthedocs environment has the hoverxref plugin.

@cbkerr
Copy link
Member Author

cbkerr commented Mar 30, 2023

Is this meant to cover all uses of the glossary terms?

Yes, these terms shouldn't have multiple definitions.

I tried to pick the ones that had most settled in the google doc.

@b-butler
Copy link
Member

I more meant, that many of the terms do not use hoverxref in the rest of the documentation.

Base automatically changed from feat/signac_2 to main March 30, 2023 19:19
@cbkerr cbkerr merged commit 07a209b into main Mar 30, 2023
@cbkerr cbkerr deleted the glossary branch March 30, 2023 19:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants