search

fedora-infra / fasjson

GNU General Public License v3.0
9 stars 15 forks source link

Improve the usage documentation #212

Open abompard opened 3 years ago

abompard commented 3 years ago

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

abompard commented 2 years ago

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

onyiipaula commented 6 months ago

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

abompard commented 6 months ago

Sure, thanks for working on it!

onyiipaula commented 6 months ago

@abompard should the file format remain at rst?

abompard commented 6 months ago

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.