How dongowu/note works
Project type and purpose
• This is not an executable application but a markdown‐based “note” repository (a static docs site / knowledge base).
• Purpose: organize technical learnings (DevOps, frameworks, languages, leetcode, micro-services, middleware, system design, etc.) and serve them via a static site or docs viewer.
File structure
• Top-level directories are content modules:
• devOps, framework, language/go, leetcode, micro-service, middleware (subfolders for Elasticsearch, Kafka, MySQL, Redis, etc.), system_design, trouble, utils.
• There are no code artifacts beyond markdown; no build scripts or config files (e.g., mkdocs.yml, Docusaurus config), so the “build” phase is implicit.
README for additional insights
• We infer that the content is intended for rendering by a static‐site generator or plain GitHub‐hosted docs.
a. Main components
• Content Repository (Git) – holds all markdown files in categorized directories.
• Local Editor – user edits/commits markdown.
• CI/CD Pipeline (optional) – job that triggers on Git push, runs a static site generator.
• Static Site Generator – transforms markdown into HTML/CSS/JS (e.g., MkDocs, Hugo, Docusaurus).
• Hosting / CDN – where the generated site is published (GitHub Pages, Netlify, Vercel).
• End-User Browser – consumes the hosted documentation.
b. Relationships & interactions
1. Developer edits markdown locally → commits & pushes to Git repo.
2. Git push → CI/CD triggers → Static Site Generator reads content → produces static assets.
3. Generated assets → deployed to Hosting/CDN.
4. End-User browses docs via web browser; search queries hit Search Index (if used).
c. Architectural patterns / principles
• Separation of concerns: Content authoring vs. build vs. hosting.
• Immutable infrastructure for hosting static assets (CDN).
d. Key technologies
• Git for version control.
• Static site generator (pick one—e.g., MkDocs, Hugo).
• CI tool (GitHub Actions, Jenkins, GitLab CI).
• Hosting (GitHub Pages, Netlify, Vercel).
• Optional: Algolia (DocSearch) or lunr.js for client‐side search.