Skip to content

[Request]: Move callout regarding documentation revisions to the top of each Markdown doc. #920

@jglogan

Description

@jglogan

Feature or enhancement request details

For the time being we don't host the Markdown files in the docs directory anywhere and as such the only way to view the documents is to browse the repo. There are links on the README.md page but these go to the main branch and not the latest release. We do have a note to this effect with the links: https://github.com/apple/container?tab=readme-ov-file#next-steps.

However, it's easy to miss this, especially if you just drill down into the docs directory instead of accessing the docs through the README.md links, as with this example: #916 (comment).

As long as we're staying low-tech with the docs, we should move the note from the README.md file to just under the h1 in all of the ./docs files.

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomersnextItems in scope for the next few milestones

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions