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

Documentation update #11

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

fjohnson
Copy link

This is an update to the documentation. Here's a list of the changes made:

  • changed references from 'glosary' to 'glosario'
  • mention that poetry is used to build this project and include the steps to get the project up and running.
  • detail how glosario-py is kept up to date with the main glosario yaml file
  • describe how the docs can be modified and built locally

Other details:

  • It would be nice to have an expansion on usage. It is sparse right now but I can't add to it because I am uncertain of the workflow of how glosario-py and glosario are actually used in practice.
  • Would it be possible to refer to this project as glosario-py in the future instead of glosario? I find that it is confusing to reference two separate projects with the same name.
  • The "about" section on Github for the project mentions that: "glosario allows users to create and retrieve multilingual glossaries. By default, glosario provides access to a community-curated glossary hosted by The Carpentries. This repository also documents the structure expected for the glossaries that can be managed by glosario."

Right now, the package doesn't allow for setting/creating glossaries. Also there is no documentation for the structure expected for glossaries, nor am I sure why this is something that should be described, since any changes made to the glosario YAML file are made within the carpentries/glosario project and not carpentries/glosario-py. And finally, even though there is the text by default glosario provides access ... I'm not sure where else glosario-py would be reading a glossary from?

For these reasons maybe we can change the about section simply to read: glosario-py provides Python based access to the community-curated technical glossary hosted by The Carpentries.

Updated the documentation, fixed some inconsistencies in CONTRIBUTING.rst and added information on how the database file is tied to the main glosario project.
Changed intro description
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.

None yet

1 participant