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.

Sign up for GitHub

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

Jump to bottom

Document the package name in the User Guide and perhaps landing page #524

Closed
cpovirk opened this issue Jun 11, 2024 · 5 comments · Fixed by #538 or #540
Closed

Document the package name in the User Guide and perhaps landing page #524

cpovirk opened this issue Jun 11, 2024 · 5 comments · Fixed by #538 or #540
Assignees
@netdpb
Labels
documentation For issues related to user-facing documentation
Milestone
1.0 annotations r...

Comments

@cpovirk
Copy link
Collaborator

cpovirk commented Jun 11, 2024

...perhaps alongside the Maven coordinates.
@cpovirk cpovirk added the documentation For issues related to user-facing documentation label Jun 11, 2024
@cpovirk cpovirk added this to the 1.0 annotations release milestone Jun 11, 2024
@netdpb
Copy link
Collaborator

netdpb commented Jun 26, 2024

What do you mean by "landing page"? https://jspecify.dev/ or start-here?

@cpovirk
Copy link
Collaborator Author

cpovirk commented Jun 26, 2024

Hmm, good question. Probably start-here?

@netdpb netdpb self-assigned this Jun 27, 2024
@netdpb netdpb mentioned this issue Jul 1, 2024
Merged
@netdpb netdpb closed this as completed in 3562ddd Jul 2, 2024
@cpovirk
Copy link
Collaborator Author

cpovirk commented Jul 2, 2024

I don't think the User Guide changes covered this one, right?

@cpovirk cpovirk reopened this Jul 2, 2024
@netdpb
Copy link
Collaborator

netdpb commented Jul 2, 2024

I had a note in the commit that it might have closed this, and GitHub leapt to that conclusion.

@cpovirk
Copy link
Collaborator Author

cpovirk commented Jul 2, 2024

Oops, now I'm reading the PR comment :)

Now that the annotations are all linked to Javadoc, this might be sufficient to close #524 as well, at least with respect to the User Guide.

I'd still be inclined to keep this open as a reminder for me to cover it when I take care of the build-system issues, but if I fail, I don't think we need to block 1.0 over it.

@netdpb netdpb mentioned this issue Jul 2, 2024
Merged
netdpb added a commit that referenced this issue Jul 2, 2024
@netdpb
Update the start-here page (#540)
48b97d8 
Note the actual package name (fixes #524).
Note that 1.0 is upcoming, not eventual.
Fix the link to the specification.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@netdpb netdpb

Labels
documentation For issues related to user-facing documentation
Projects
None yet
Milestone
1.0 annotations release
2 participants
@cpovirk @netdpb