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

[Docs] Make page variables.html into its own directory with more detailed and accurate sub-pages #506

Open
1 of 4 tasks
Luna-Klatzer opened this issue Aug 29, 2023 · 0 comments
Assignees
Labels
docs Related to the project docs and info on the repo or website
Milestone

Comments

@Luna-Klatzer
Copy link
Member

Is there an existing issue for this?

  • I have searched the existing issues

Current State & Issue

The current page variables is rather old and outdated, as it was added in the first dev release of the Kipper docs. Until now only minor changes were performed to keep it accurate, which means most of the layout is still as it was originally. This can lead to confusion, as for example the constant page is at the bottom of the variables page without any indication of it being there.

As such it would be best to split up the page into multiple different pages, which should also cover more edge-cases and be more detailed, as the current variables page is rather generic and not very clear about some behaviour.

Expected Changes & Improvements

  • Split up the variables docs page into multiple new pages.
  • Add more details to every page to make them more clear.
  • Add more examples of variable usage.

Referenced sites

@Luna-Klatzer Luna-Klatzer added the docs Related to the project docs and info on the repo or website label Aug 29, 2023
@Luna-Klatzer Luna-Klatzer added this to the Improved Docs milestone Aug 29, 2023
@Luna-Klatzer Luna-Klatzer self-assigned this Aug 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to the project docs and info on the repo or website
Projects
Status: Todo
Development

No branches or pull requests

1 participant