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

Simplify learning the syntax from the docs #1473

Open
kof opened this issue Mar 21, 2021 · 2 comments
Open

Simplify learning the syntax from the docs #1473

kof opened this issue Mar 21, 2021 · 2 comments
Labels
docs Code is fine, documentation is not. enhancement No kittens die if we don't do that. help wanted

Comments

@kof
Copy link
Member

kof commented Mar 21, 2021

Is your feature request related to a problem? Please describe.

Currently people can't discover all syntaxes supported on a single page, because there are plugins which define syntactic extensions

Latest instance #1472

Describe the solution you'd like

Some way to discover the entire syntax, maybe we should have a combined overview that takes all syntactic extensions into account and links to the more complete plugin docs

Are you willing to implement it?
No

@kof kof added enhancement No kittens die if we don't do that. help wanted labels Mar 21, 2021
@kof
Copy link
Member Author

kof commented Mar 21, 2021

As an idea, maybe we need to reorganize the navigation and content on the docs site:
Right now it's structured "by package", each package is in the menu, each package provides docs for syntax and api.

We could organise it by Syntax and by APIs, meaning

Syntax
  - Core
  - Plugin X
  - Plugin Y
API
  - Core
  - Plugin X
  - Plugin Y

When user goes to page "Syntax" they scroll the entire syntax, including all plugins, navigation would highlight the current package/plugin, but it would feel like a single document.

@kof
Copy link
Member Author

kof commented Mar 21, 2021

We can still keep each documentation where they are right now, in the corresponding package, just render them differently, providing a better reading experience.

@kof kof added the docs Code is fine, documentation is not. label Mar 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Code is fine, documentation is not. enhancement No kittens die if we don't do that. help wanted
Projects
None yet
Development

No branches or pull requests

1 participant