-
Notifications
You must be signed in to change notification settings - Fork 49
docs(configuration): fill page content #307
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(configuration): fill page content #307
Conversation
v0.17.0
v0.17.0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the initial work on this PR!
I added a few comments, if anything is not clear don't hesitate to ask me 🙂.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this page is too verbose.
I think the best it to reduce all the content to just a list with a quick description, default value, etc (vite example).
I'd put example only on very esoteric configuration entry (that IMHO we don't have yet).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's go ahead with something like:
# Configuration
short desc + snippet to display where to import TuonoConfig
## vite
Mention about that this is a wrapper to some of vite options
### vite.option1
short desc
### vite.option2
short desc
### vite.option3
short desc
I made the changes as per review comments @marcalexiei I used the template you described above, with just one additional section - "Using Vite alias for Path configuration" Let me know if that section is required, else I will remove that from documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I used the template you described above, with just one additional section - "Using Vite alias for Path configuration"
I replaced this section with a note inside "vite.alias" section.
This note informs the user that a working example can be found in tuono-tutorial template and in the documentation code.
In the future, if users encounter trouble configuring the alias property, I would consider adding a section similar to the one you proposed on a standalone page, turning the 'Configuration' nav option into an accordion, like 'Getting Started,' 'Tutorial,' and others.
Additional changes
- I noticed a problem in the MDXProvider configuration:
(bold item were printed inside a<div />
tag so I replaced it with aspan
- reword and format content
- applied prettier format
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
Thanks for taking care of this!
Context & Description
Close #303
Fill tuono.config.ts with
vite
references.