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

Getting Started flow skips most docs, sends to Reference early #774

Closed
stevegt opened this issue Oct 2, 2022 · 2 comments · May be fixed by #775
Closed

Getting Started flow skips most docs, sends to Reference early #774

stevegt opened this issue Oct 2, 2022 · 2 comments · May be fixed by #775

Comments

@stevegt
Copy link
Sponsor

stevegt commented Oct 2, 2022

When going through /getting-started, I found that the "Next" link in /architecture sends folks directly to /reference. That gave me a first impression that there was no more documentation other than the API reference. A better "next" path from /architecture would be /components. Components is already set up to send people to declarative, routing, etc. after that.

Fixing this would provide a much smoother learning curve and likely higher adoption. In my own case, hitting /reference so quickly caused me to spend an afternoon looking for alternatives to go-app before I realized what the problem was.

stevegt added a commit to stevegt/go-app that referenced this issue Oct 2, 2022
@stevegt stevegt changed the title Documentation issue in Architecture page: "Next" should point to components instead of Reference Documentation issue in Architecture page: "Next" should point to Components instead of Reference Oct 2, 2022
@stevegt
Copy link
Sponsor Author

stevegt commented Oct 2, 2022

Same problem in /states -- should send to /notifications. Will add to PR.

stevegt added a commit to stevegt/go-app that referenced this issue Oct 2, 2022
@stevegt stevegt changed the title Documentation issue in Architecture page: "Next" should point to Components instead of Reference Getting Started flow skips most docs, sends to Reference early Oct 2, 2022
stevegt added a commit to stevegt/go-app that referenced this issue Dec 8, 2022
stevegt added a commit to stevegt/go-app that referenced this issue Dec 8, 2022
@maxence-charriere
Copy link
Owner

Documentation will be revamped and moved away from this repo.

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 a pull request may close this issue.

2 participants