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

Documentation #52

Open
edward3h opened this issue Sep 30, 2024 · 0 comments
Open

Documentation #52

edward3h opened this issue Sep 30, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request milestone1 Tasks for the first release

Comments

@edward3h
Copy link
Owner

README will contain a "quick start" section. Fuller documentation will be in a "docs" directory, and will generate a website during release. The website could be on github pages, or my own web host.

Asciidoc will be used. It can embed code samples, which can be part of the build so we know they are valid.
@edward3h edward3h added documentation Improvements or additions to documentation enhancement New feature or request milestone1 Tasks for the first release labels Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request milestone1 Tasks for the first release
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@edward3h