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

Documentation Guide section is now more structured #116

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

fazpu
Copy link
Contributor

@fazpu fazpu commented Dec 27, 2022

This is an attempt to give the docs a bit more structure so that it is easier to orient around:

image

visual components

image

form components

image

custom clickable components

image

formatting text and numbers

image

@fazpu fazpu requested a review from lo5 as a code owner December 27, 2022 16:53
@lo5
Copy link
Member

lo5 commented Jan 4, 2023

@fazpu Thanks for the PR.

I like the restructuring you've done, but unfortunately this PR can't be merged because the included files are auto-generated from the guide *.py files using this.

The correct way to perform this kind of restructuring would be to introduce the concept of a hierarchy in the guide files, then modify the generator to handle the hierarchy. Needs some planning/design.

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

Successfully merging this pull request may close these issues.

None yet

2 participants