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

Improve and rewrite the documentation #5

Open
thoughtpolice opened this issue Feb 12, 2020 · 0 comments
Open

Improve and rewrite the documentation #5

thoughtpolice opened this issue Feb 12, 2020 · 0 comments
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

Comments

@thoughtpolice
Copy link
Owner

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.

@thoughtpolice thoughtpolice added help wanted Extra attention is needed good first issue Good for newcomers A-task A task that needs to be done E-easy Easy issues P-high High priority issues labels Feb 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

1 participant