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: Organise it! #112

Closed
VorpalBlade opened this issue Apr 8, 2024 · 1 comment
Closed

Documentation: Organise it! #112

VorpalBlade opened this issue Apr 8, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@VorpalBlade
Copy link
Owner

VorpalBlade commented Apr 8, 2024 •
edited
Loading

It is a bit all over the place currently:

  • In the README
  • In docs/
  • In --help-syntax and --help-transforms

Note that --help-transforms is generated from each transformation doc comment currently, so not ideal for generating markdown from. In general it would be nice to have a single source of truth to generate a github pages / mdbook from though.
@VorpalBlade VorpalBlade added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 8, 2024
@VorpalBlade
Copy link
Owner Author

This has now been done (a new mdbook based website has been created).

As a followup task, the --help-syntax output should be generated from the markdown file somehow. Possibly the same for --help-transforms.

@VorpalBlade VorpalBlade mentioned this issue May 11, 2024
Open
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@VorpalBlade