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.

Sign up for GitHub

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

Jump to bottom

Improve the usage documentation #212

Open
abompard opened this issue May 21, 2021 · 5 comments
Open

Improve the usage documentation #212

abompard opened this issue May 21, 2021 · 5 comments
Assignees
@onyiipaula
Labels
documentation Improvements or additions to documentation EasyFix Good for newcomers next phase Will be done in the next phase of development

Comments

@abompard
Copy link
Member

The usage documentation is in a pretty sorry state, it should be improved. Don't forget to mention field masks in there too.
@abompard
Copy link
Member Author

Also document which fields match on substrings and which match exactly.

@abompard abompard added documentation Improvements or additions to documentation EasyFix Good for newcomers labels Sep 1, 2023
@ryanlerch ryanlerch added the next phase Will be done in the next phase of development label Jan 29, 2024
@onyiipaula
Copy link

Hi, i'm an outreachy intern and i would love to be assigned to this

@abompard
Copy link
Member Author

abompard commented Mar 7, 2024

Sure, thanks for working on it!

@onyiipaula
Copy link

@abompard should the file format remain at rst?

@abompard
Copy link
Member Author

abompard commented Mar 8, 2024

No it doesn't have to, but it should be built by Sphinx as it is now. Sphinx has support for markdown using the Myst-parser plugin.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@onyiipaula onyiipaula

Labels
documentation Improvements or additions to documentation EasyFix Good for newcomers next phase Will be done in the next phase of development
Projects
Phase Two
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
3 participants
@abompard @ryanlerch @onyiipaula