docs: create the docs using mkdocs and docs pages pipeline - #2
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds an MkDocs-based documentation site for PgPulse and enables automated GitHub Pages deployment.
Changes:
- Introduces
mkdocs.ymland a full set of docs pages underdocs/ - Adds a GitHub Actions workflow to build (and deploy on non-PR events) the MkDocs site
- Updates
.gitignoreto exclude generated docs output and local tooling artifacts
Reviewed changes
Copilot reviewed 13 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Configures MkDocs Material theme and documentation navigation |
| docs/index.md | Adds project landing page and high-level overview |
| docs/quick-start.md | Documents local Docker-based quick start flow |
| docs/architecture.md | Documents system architecture and data flow |
| docs/configuration.md | Documents extension + exporter configuration surfaces |
| docs/extension.md | Documents extension build/install/configure steps and SQL surface |
| docs/exporter.md | Documents exporter build/run/config + endpoints |
| docs/metrics-and-apis.md | Documents Prometheus metrics, HTTP API, and SQL API |
| docs/operations.md | Adds day-2 operational checks and workflows |
| docs/troubleshooting.md | Adds troubleshooting guide for common failure modes |
| docs/aws-rds-approval.md | Documents what would be required for native RDS availability |
| .github/workflows/deploy-docs.yml | Adds GitHub Pages build/deploy workflow for MkDocs site |
| .gitignore | Ignores MkDocs site/ output and some local tooling files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+9
to
+11
| push: | ||
| branches: | ||
| - master |
Comment on lines
+41
to
+44
| - name: Install docs dependencies | ||
| run: | | ||
| python -m pip install --upgrade pip | ||
| python -m pip install mkdocs mkdocs-material |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.