Improve and rewrite the documentation #5
Labels
A-task
A task that needs to be done
E-easy
Easy issues
good first issue
Good for newcomers
help wanted
Extra attention is needed
P-high
High priority issues
Milestone
What needs to be done
The documentation needs a rework and update; in particular several of the features implemented since the initial draft are completely undocumented (like JSON
.narinfo
results or re-signing mode.)Furthermore, I've come to determine that while I like org mode as an Emacs user, I dislike it as an actual format for project documentation (or at least GitHub frontmatter), so the README and CHANGELOG need to be rewritten as well.
I think it would be nice to use something like Sphinx and GitHub Actions to synchronize things appropriately so e.g. https://thoughtpolice.github.io/eris worked.
Alternatives considered
None: this must be implemented.
Additional notes
None.
The text was updated successfully, but these errors were encountered: