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

Organize readme #2608

Open
john-cd opened this issue Jan 29, 2025 · 2 comments
Open

Organize readme #2608

john-cd opened this issue Jan 29, 2025 · 2 comments

Comments

@john-cd
Copy link

john-cd commented Jan 29, 2025

The manual is quite complete, but is very "flat" and could use a bit more structure e.g.

  • Features

    • Recipes
      • Regular recipes
      • Private recipes
      • Shebang recipes
        • Safer shebang recipes
      • Script recipes
      • ...
    • Aliases
    • Variables
    • Expressions
      • Conditional Expressions
      • ...
    • Attributes
    • Settings
    • Imports and Modules
      • ...
  • Examples

    • Python
    • ...

Also consider adding to your book.toml - see https://rust-lang.github.io/mdBook/format/configuration/renderers.html

[output.html.fold]
enable = true # whether or not to enable section folding
level = 0 # the depth to start folding

@john-cd
Copy link
Author

john-cd commented Jan 29, 2025

Also a lot of the stuff in https://github.com/casey/just/README.md could be moved to the manual, I think?

@casey
Copy link
Owner

casey commented Jan 29, 2025

Agreed, I think it could use better organization. I'm not sure about folding though, I like being able to ctrl-f find sections, which you wouldn't be able to do if they were folded.

The manual is generated from the readme, so the content is the same.

@casey casey changed the title Documentation structure Organize readme Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants