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 directly to targets #1536

Open
gregsdennis opened this issue Sep 30, 2024 · 4 comments
Open

Link directly to targets #1536

gregsdennis opened this issue Sep 30, 2024 · 4 comments
Labels
core proposal Initial discussion of a new idea. A project will be created once a proposal document is created. validation

Comments

@gregsdennis
Copy link
Member

With the spec docs now in markdown and with us self-hosting the files, should we move to having links go directly to their targets rather than to an appendix (which is IETF style)? Personally, I never liked linking to an appendix.

OpenAPI uses direct links, which you can see with the JSON Schema spec link in Section 4.4.

@jdesrosiers
Copy link
Member

I agree. The appendix is unnecessary.

@gregsdennis gregsdennis added core validation proposal Initial discussion of a new idea. A project will be created once a proposal document is created. labels Oct 2, 2024
@gregsdennis gregsdennis added this to the stable-release milestone Oct 2, 2024
@gregsdennis
Copy link
Member Author

gregsdennis commented Oct 2, 2024

I'm happy for anyone who wants to do this to take it.

For references to specific sections of the target, the links should go directly to that section (or as close as possible).

@SanidhyaMadheshia
Copy link

I think an appendix is not preferred by many contributors . And if direct linking enhances usability without sacrificing clarity, it could be a beneficial shift.

@gregsdennis
Copy link
Member Author

@jdesrosiers do we have support in the markdown processor to link between files? For example, if I wanted to reference the security concerns section in Core from Validation, could I do something like [Security Concerns in Core](core.md#security) or {{core#security}}?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core proposal Initial discussion of a new idea. A project will be created once a proposal document is created. validation
Projects
Status: Awaiting PR
Development

No branches or pull requests

3 participants