Skip to content

docs(readme): add direct access links to design document and project presentation - #174

Merged
Decuayer merged 1 commit into
mainfrom
docs/add-design-doc-and-presentation-links
Sep 27, 2026
Merged

Decuayer merged 1 commit into
mainfrom
docs/add-design-doc-and-presentation-links

Conversation

@Decuayer

Copy link
Copy Markdown
Owner

🎯 Jira / Task Reference

  • Component: [documentation]

📝 Summary of Changes

  • Added direct-access badges and a centered quick navigation bar at the top of README for the System Design Document and Final Project Presentation PDFs.
  • Embedded an executive deliverables callout block (> [!NOTE]) with summary descriptions of each document.
  • Updated Section 1 (Architecture), Section 8 (Repository Structure tree), and Section 9 (Project Origins) with references to the archived artifacts.

🏷️ Type of Change

  • 📖 Documentation: README, API specs, or code documentation updates

📋 Pre-Merge Checklist

  • My code adheres to the project's Clean Architecture & style guidelines.
  • I have self-reviewed my own code before requesting review.

…presentation

- Add header badge and quick navigation bar for design document and presentation PDF
- Add executive deliverables note callout before system architecture section
- Update Section 1, repository tree structure, and project background references
@github-actions github-actions Bot added the docs label Sep 27, 2026
@Decuayer
Decuayer merged commit 6d23b43 into main Sep 27, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant