How ekonurwahyudi/atemis-2.0-guide-book works
File structure
• Top-level folders:
• .gitbook / .gitbook/assets – configuration and binary/PDF assets.
• getting-started, input-order, material-request, master-data, website-kalibrasi, file-pendukung – these are content modules, each with multiple Markdown files.
• Root files: README.md, SUMMARY.md – GitBook entry points.
• No server-side code, build scripts or Dockerfiles exist here, so the “architecture” is essentially a static content pipeline.
README
• Describes the business context of Atemis 2.0 (maintenance workflows at TELKOM).
• No technical architecture section visible. The documentation is organized by feature (Replacement & Repair, Kalibrasi, Bantek, Warehouse).
Main components
a. Content Source
– A Git repository containing:
• Markdown modules (input-order, master-data, etc.)
• .gitbook config and assets
• SUMMARY.md (navigation map)
b. Build Layer
– GitBook CLI (or GitBook.com build service) that:
• Reads SUMMARY.md + Markdown files
• Processes .gitbook config and assets
• Generates static HTML/CSS/JS site
c. CI/CD Pipeline
– (Optional) GitHub Actions / GitLab CI / other that:
• Triggers on push to main
• Installs GitBook CLI
• Builds static output
• Deploys artifacts
d. Hosting/Deployment
– GitBook Cloud or third-party hosting (e.g., Netlify, GitHub Pages) serving the static site.
e. End-User
– Web browser or PDF export (GitBook provides PDF/ebook generation).
Relationships & interactions
• Developers push Markdown changes → Git repository
• CI/CD picks changes → invokes GitBook build
• Build step pulls in config/assets & content → outputs static site
• Deployed site served to end-users via CDN/hosting
• End-users navigate sections, download PDF, view embedded assets
Architectural patterns & design principles
• Content-as-code: Markdown files in Git
• Static site generation: no server-side runtime, improves performance & security
• Modular documentation: each feature area is its own directory, recapitulating single-responsibility
• CI/CD for automated publishing
Technologies, frameworks, libraries
• GitBook CLI or GitBook.com
• Markdown
• Node.js (underlying GitBook engine)
• Optional: GitHub Actions / Netlify / AWS S3 + CloudFront
• Standard web stack for static HTML/CSS/JS
Key points
• The .gitbook folder and SUMMARY.md as configuration inputs
• Build engine (GitBook CLI) processing into static files
• CI/CD pipeline connecting repo to build to deploy
• Deployment target (GitBook cloud or other)
• End-user consumption via web or PDF export