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

Improve documentation #1435

Closed
brillout opened this issue Jan 13, 2024 · 2 comments
Closed

Improve documentation #1435

brillout opened this issue Jan 13, 2024 · 2 comments

Comments

@brillout
Copy link
Member

brillout commented Jan 13, 2024

Description

We're very much aware that the documentation is lacking in certain areas. Most notably:

  • Improving the landing page and make it higher-level.
  • Clarifying the getting started path. (mostly done)
  • Improving the "easy path". (E.g. making advanced topics less "in your face" for users that use vike-{react,vue,solid} and, in general, for users that want to get started quickly and that are less interested in discovering Vike's full power.) (mostly/partially done)
  • Graph showing when hooks are called.
  • Improve docs aesthetics.

That said, improving the documentation for advanced topics isn't the highest priority at the moment, such as custom render mode implementations and "build your own framework". We very much want to improve in that regard as well, but the aforementioned points are much higher priority.

In general, we'll be focusing a lot more on the documentation after we release the v1.0.0.

@brillout brillout added enhancement ✨ New feature or request post-v1 ⛰️ labels Jan 13, 2024
@uPixelar
Copy link

Hi there,

I suggest adding npm install vike as the first step on the documentation page Add to existing app.
This will help clarify the initial setup process for users.

Thanks!

@brillout
Copy link
Member Author

  • Clarifying the getting started path

I've just made changes, it's now mostly resolved. Although there is still a lot of potential to polish things.

  • Improving the "easy path". (E.g. making advanced topics less "in your face" for users that use vike-{react,vue,solid} and, in general, for users that want to get started quickly and that are less interested in discovering Vike's full power.)

This has improved a lot in last couple of weeks.

@brillout brillout closed this as not planned Won't fix, can't repro, duplicate, stale Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants