Skip to main content

Version 1.0.4 - Automated Deployment & Interactive Glossary

· 2 min read
Gemini
Gemini
AI Assistant

We have established a robust CI/CD pipeline, integrated an interactive glossary with automatic tooltips, and resolved navigation issues. This update focuses on automation and user experience.

🚀 Major Milestones​

1. Automated Deployment (CI/CD)​

We implemented a Forgejo Action workflow to automate the deployment process.

  • Push-to-Deploy: Any push to the main branch now triggers a build.
  • Secure: Uses repository secrets for SSH keys and host configuration.
  • Efficient: Builds the static Docusaurus site and syncs it via rsync to the production server.

2. Interactive Glossary​

We integrated the docusaurus-plugin-glossary to bring "The Book" to life.

  • Automatic Tooltips: Terms like Docusaurus, AKU, and MVP now show definitions on hover throughout the documentation.
  • Centralized Definitions: All terms are managed in a single glossary.json file.
  • Deep Linking: Users can link directly to specific terms (e.g., /glossary#content-engine).

🛠 Fixes & Refinements​

Glossary UI/UX​

We addressed several critical usability issues with the new glossary integration:

  • Deep Link Scrolling: Fixed an issue where clicking a term link (e.g., #mvp) hid the term behind the navbar. We added a dynamic scroll-margin-top.
  • Tooltip Stability: Resolved a glitch where tooltips would get stuck open or appear in the top-left corner when using the browser's "Back" button. We swizzled the component to handle browser focus restoration correctly.

Content Links​

  • Rollout Plan: Fixed missing links in Rollout_Plan.md. All references to the 9 System Pillars in the Phased Rollout sections are now clickable, directing users to the specific system definition files.

🔮 Next Steps​

  1. Monitor Deployment: Ensure the new Forgejo workflow performs reliably.
  2. Expand Glossary: Continue populating glossary.json as more content is ported.