Skip to content

Activity Report Overview Creation

Ticket: #100 Creation of the Activity Report Overview page
Type: Documentation / Navigation Improvement
Affected Component: docs/activity_report/, docs/fr/activity_report/, mkdocs.yml

1. Context

The project's activity reports were previously only accessible through the automatically generated sidebar menu. As the number of reports grew, it became necessary to have a dedicated, central entry point that summarizes the project's interventions and acts as a logbook.

2. Objective

Create a central "Overview" page for activity reports to: - Summarize recent changes and project interventions. - Provide direct links to detailed activity reports. - Maintain a clear timeline and history of actions. - Offer improved navigation independent of just the table of contents.

3. Actions Taken

  • Created Overview Pages: Added docs/activity_report/index.md and docs/fr/activity_report/index.md.
  • Content Formatting: Listed all existing activity reports chronologically with a clear title, date, type, short description, and a direct link to the full report.
  • Navigation Update: Modified mkdocs.yml to set the new "Overview" page as the first link under the "Activity Reports" section for both English and French menus.
  • Branch Management: Created a new branch feature/activity-report-overview to cleanly integrate these changes.

4. Result

Users and stakeholders now have a structured, easily scannable "Overview" page that acts as a project logbook. It improves discoverability of past interventions without breaking any existing navigation or links.

5. Next Steps

  • Continue to log future project changes using this new structure.
  • Ensure all new activity reports are added to the Overview page.