这是indexloc提供的服务,不要输入任何密码
Skip to content

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

Merged
merged 5 commits into from
Jan 14, 2025

Conversation

avj2352
Copy link
Contributor

@avj2352 avj2352 commented Jan 13, 2025

Context & Description

Close #303

Fill tuono.config.ts with vite references.

@avj2352 avj2352 changed the title v0.17.0 - Added documentation for configuration page docs(configuration): Added documentation for configuration page v0.17.0 Jan 13, 2025
@marcalexiei marcalexiei changed the title docs(configuration): Added documentation for configuration page v0.17.0 docs(configuration): fill page content Jan 13, 2025
@marcalexiei marcalexiei added the documentation Improvements or additions to documentation label Jan 13, 2025
Copy link
Collaborator

@marcalexiei marcalexiei left a 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 🙂.

Copy link
Member

@Valerioageno Valerioageno left a 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).

Copy link
Collaborator

@marcalexiei marcalexiei left a 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

@avj2352
Copy link
Contributor Author

avj2352 commented Jan 13, 2025

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.

Copy link
Collaborator

@marcalexiei marcalexiei left a 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 a span
  • reword and format content
  • applied prettier format

Copy link
Collaborator

@marcalexiei marcalexiei left a 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!

@marcalexiei marcalexiei merged commit 64220f2 into tuono-labs:main Jan 14, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation]: add tuono.config.ts reference
3 participants