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

Link from "Start Here" page to whether, using, and maybe other docs? #576

Open
cpovirk opened this issue Jul 19, 2024 · 1 comment
Open
Labels
documentation For issues related to user-facing documentation

Comments

@cpovirk
Copy link
Collaborator

cpovirk commented Jul 19, 2024

It's a little sad that the home page's "Learn More" link leads to a "Start Here" page that currently links to those docs only from the sidebar. As more people come across our home page (as opposed to landing initially on our 1.0 blog post or our release notes), I think we'll want more prominent links to the discussions of whether and how to use our annotations. (Really, it might be nice for https://jspecify.dev/ itself to serve the "Start Here" page, since users currently have to follow a couple links just to get to, e.g., the Maven coordinates. I have no concept of how hard that part would be to pull off. Maybe we could at least get various direct links in the section that currently has items like "Standard Annotations?")

@cpovirk cpovirk added the documentation For issues related to user-facing documentation label Jul 19, 2024
@kevinb9n
Copy link
Collaborator

kevinb9n commented Aug 5, 2024

Please do edit the start-here page!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation For issues related to user-facing documentation
Projects
None yet
Development

No branches or pull requests

2 participants