Skip to content

Documentation overhaul - #1102

Open
darrendignam wants to merge 47 commits into
openpreserve:integrationfrom
darrendignam:pr/docs-overhaul-upstream
Open

Documentation overhaul#1102
darrendignam wants to merge 47 commits into
openpreserve:integrationfrom
darrendignam:pr/docs-overhaul-upstream

Conversation

@darrendignam

@darrendignam darrendignam commented May 21, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR updates the JHOVE documentation site with a broad usability and presentation overhaul. The goal is to make the docs easier to navigate, easier to read, and more consistent across sections while keeping the existing content structure intact.

A live demo of this docs site can be seen here:
https://jhove.darrendignam.com/

What changed

  • Added breadcrumbs across the docs so users can see where they are in the site hierarchy.
  • Added a full documentation sidebar with hierarchical navigation for the site structure.
  • Standardized front matter across docs pages so navigation metadata is consistent.
  • Fixed parent/title mismatches so section pages and child pages resolve correctly in navigation.
  • Added a new documentation page explaining how to edit and contribute to the docs.
  • Improved the overall visual design of the docs:
    • more deliberate color usage
    • clearer navigation states
    • added dark mode

Note

  • This is primarily a documentation and UX pass; no functional JHOVE application behavior is intended to change.

Removing the debug step in the file creats a weird situation where the file is not present - a race condition wit the previous checkout command?
…op functionality, and improve CSS variables for better theming support
… add responsive styles for theme toggle in navbar
…ation clarity; standardize parent key capitalization in module documentation
…y; adjust button gap and enforce nowrap for better layout
…g; implement collapsible sections and update CSS for better layout and accessibility
@darrendignam
darrendignam requested a review from ross-spencer May 21, 2026 19:33
@darrendignam
darrendignam requested a review from carlwilson May 21, 2026 20:29
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