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

Improve searchability of release notes #470

Closed

Conversation

eviau-artefactual
Copy link
Contributor

Adding the release notes to the general documentation to help people figure out when changes were made.

This option makes them available though a rst file rendered in HTML in the docs.

We could also make it a .md file and host it on GitHub.

@eviau-artefactual
Copy link
Contributor Author

eviau-artefactual commented Jul 22, 2024

Demo for now: https://github.com/artefactual/archivematica-docs/blob/6efe8bcfcfde27c6e63cbe929bf2b62c4085f912/releasenotes.rst

TODO:

  • - fix headings levels
  • - maybe add list of current releases as TOC

@eviau-artefactual eviau-artefactual changed the title [WIP] Improve findability and searchability of release notes Improve findability and searchability of release notes Jul 23, 2024
@eviau-artefactual eviau-artefactual changed the title Improve findability and searchability of release notes Improve searchability of release notes Jul 23, 2024
@eviau-artefactual
Copy link
Contributor Author

Headings are fixed.

ToC display of headings is managed at the theme level.

@eviau-artefactual
Copy link
Contributor Author

Closing in favor of artefactual/archivematica#1968

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

Successfully merging this pull request may close these issues.

1 participant