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

Embedding the documentation within the web application #164

Open
cardillan opened this issue Oct 18, 2024 · 0 comments
Open

Embedding the documentation within the web application #164

cardillan opened this issue Oct 18, 2024 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@cardillan
Copy link
Owner

The documentation is currently presented in a series of markdown files directly in the GitHub page. Serving the documentation from within the app would have these advantages:

  • The documentation would be more at hand.
  • Some parts of the documentation are already dynamically generated into the static markdown files during the build, this could be improved.
  • Better presentation of code examples
    • Perhaps code on the left, mlog output on the right
    • The examples would be kept is separate files and would be compiled during build (unit tests), difference from the expected output would be inspected, as
      • all examples should always correspond to current compiler output,
      • when the output of the example changes, it needs to be reviewed - it might indicate an error, or maybe changes to the compiler/optimizer changed the output in such a way it no longer serves the purpose of the example.
  • Additional dynamic contents
    • List of keywords
    • List of Mindustry contents (items, liquids, units, building types, sounds, ...)
    • List of experimental and deprecated features (?)
  • Needs to have support for configurable redirects when the structure of the documentation changes.
  • Optional enhancements
    • The source code and output might be integrated with the compilation engine and allow altering and compiling the examples in place

Things that needs to be figured out:

  • The primary format of the documentation to be rendered on the web page (maybe slightly enhanced markdown?)
@cardillan cardillan added enhancement New feature or request help wanted Extra attention is needed labels Oct 18, 2024
@cardillan cardillan changed the title Embedding the documentation within the application Embedding the documentation within the web application Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant