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

Some RFD interlinking is broken #104

Open
Keno opened this issue Mar 27, 2024 · 2 comments
Open

Some RFD interlinking is broken #104

Keno opened this issue Mar 27, 2024 · 2 comments
Assignees

Comments

@Keno
Copy link

Keno commented Mar 27, 2024

I hope this is the correct place to post this. I was idly browsing the RFD pages, when I noticed that a number of inter-RFD links are broken. For example, in https://rfd.shared.oxide.computer/rfd/0024, in section 4.4.3 (https://rfd.shared.oxide.computer/rfd/0024#_networking), there is a link to RFD21, but the link target is https://github.com/oxidecomputer/rfd/tree/master/rfd/0021 rather than https://rfd.shared.oxide.computer/rfd/0021. Note that it does have a hoverover to show metadata, so some part of the pipeline is clearly recognizing this.

@benjaminleonard
Copy link
Contributor

Many RFDs, especially if they predate the current RFD site will link to the documents on Github instead (which you would not have access to).

The hover preview uses a slightly cursed regex to discover any RFD links, and in theory we could preprocess the document to change all of these to RFD site links. I think we'd eventually link a linter to catch this stuff, along with some other formatting issues that crop up from time to time.

Good catch, and thanks for reporting.

@augustuswm augustuswm self-assigned this Mar 27, 2024
@augustuswm
Copy link
Contributor

augustuswm commented Mar 27, 2024

Agreed, it would be good to have a processor step that rewrites urls like these. There are some caveats in that we attempt to keep the api independent from the frontend display. So it will definitely need to be an opt-in via configuration case. I'll look at putting something like that together.

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

No branches or pull requests

3 participants