Skip to content

Correct "Edit this page" links #20

@mjherzog

Description

@mjherzog

On all of the PURL Specification pages and on the VERS Specification / Documentation page there is an "Edit this page" link at the bottom of each page - they all return a "Not found" message. For the PURL Specification / PURL Types page the URL for the edit link is: https://github.com/package-url/docs/purl-spec/purl-spec-purl-types.md so I understand the error message.

We need to either correct the URLs to point to the source markdown file in the purl-spec repo or at least temporarily remove the "Edit this page" links. I am guessing that getting the URLs to function accurately may be difficult while the website is in flux, so removing the links would be fine for now, but we will want to get this working like it does for https://relay.dev/docs/ at some point.

For the PURL Specification / Documentation page or other pages composed of multiple markdown files it would be a bonus to be show an Edit link for each markdown file so that the reader can easily see where the text originates from. This might require breaking the long Documentation page into a set of pages that map to the markdown files - we do not want to send the reader to the generated purl-specification.md file.

We will want consistent behavior for this on all pages as we replace the lorem ipsum placeholders with real text.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions