Skip to content

docs: add architecture, development, contributing documentation and refactor readme - #13

Merged
lemyskaman merged 1 commit into
mainfrom
fix/documentation
Jun 20, 2026
Merged

lemyskaman merged 1 commit into
mainfrom
fix/documentation

Conversation

@lemyskaman

Copy link
Copy Markdown
Member

Summary

This PR adds comprehensive documentation for the project:

  • docs/Architecture.md — Detailed system architecture with Mermaid diagrams (system overview, data flows, sequence diagrams, type system, interrelationship map) and a 25+ term glossary
  • docs/DEVELOPMENT.md — Developer standards guide covering SOLID/DRY principles, TypeScript standards, linting, Husky hooks, trunk-based Git workflow, GitHub Actions CI/CD, Docker environment, and local package installation via npm link/file:
  • CONTRIBUTING.md — Contributor onboarding guide with Code of Conduct, bug/enhancement reporting, development setup, PR process, quality gates, commit conventions, testing requirements, and release process
  • README.md — Fully refactored with concise overview, installation/integration guide, feature documentation with code examples, and documentation index

All documentation reflects current codebase state (Vite plugin with content pipeline, SSG pipeline, virtual module, React hooks, SEO, CLI, Docker, automated semantic-release via OIDC).

@lemyskaman
lemyskaman merged commit 1f2bb58 into main Jun 20, 2026
4 checks passed
@lemyskaman
lemyskaman deleted the fix/documentation branch June 20, 2026 16:25
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 2.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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