Skip to content

Commit 44c4d16

Browse files
irahardiantoirahardianto
committed
update readme, configure github pages
1 parent 500ef6d commit 44c4d16

File tree

11 files changed

+2041
-11
lines changed

11 files changed

+2041
-11
lines changed

‎.github/workflows/deploy-pages.yml‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Deploy GitHub Pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
paths:
7+
- "github-pages/**"
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v4
25+
26+
- name: Setup Pages
27+
uses: actions/configure-pages@v5
28+
29+
- name: Build with Jekyll
30+
uses: actions/jekyll-build-pages@v1
31+
with:
32+
source: ./github-pages
33+
destination: ./_site
34+
35+
- name: Upload artifact
36+
uses: actions/upload-pages-artifact@v3
37+
38+
deploy:
39+
environment:
40+
name: github-pages
41+
url: ${{ steps.deployment.outputs.page_url }}
42+
runs-on: ubuntu-latest
43+
needs: build
44+
steps:
45+
- name: Deploy to GitHub Pages
46+
id: deployment
47+
uses: actions/deploy-pages@v4

‎README.md‎

Lines changed: 109 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@ You can drop this configuration into the context or custom rule settings of:
3131

3232
For example, the principles of the [Rugged Software Constitution](.agent/rules/rugged-software-constitution.md) which is based on [Rugged Software Manifesto](https://ruggedsoftware.org/) are universal and will improve the output of any LLM-based coding assistant.
3333

34+
### Key Features
35+
36+
* 📏 **30 Rules** — covering security, reliability, architecture, maintainability, and DevOps.
37+
* 🛠️ **7 Skills** — specialized capabilities for debugging, design, code review, and more.
38+
* 🔄 **10 Workflows** — end-to-end development processes from research to ship.
39+
* 🏗️ **Two-Tier Rule System** — always-on mandates + contextual principles for zero-noise enforcement.
40+
3441
<!-- GETTING STARTED -->
3542
## Getting Started
3643

@@ -47,13 +54,24 @@ To equip your AI agent with these superpowers, follow these steps.
4754
```sh
4855
cp -r /path/to/antigravity-setup/.agent ./your-project-root/
4956
```
50-
2. Ensure your AI agent is configured to read from the `.agent` directory (most of well-known AI coding assistant are adhering to the `.agent` convention by default) or manually ingest the `.agent/rules/**` as part of its system prompt.
57+
2. Ensure your AI agent is configured to read from the `.agent` directory (most of well-known AI coding assistant are adhering to the `.agent` convention by default, no action needed) or manually ingest the `.agent/rules/**` as part of its system prompt.
5158

5259
<!-- USAGE -->
5360
## Usage
5461

5562
Once installed, the rules and skills in this repository become active for your agent.
5663

64+
### Rule Architecture
65+
66+
The setup uses a **two-tier rule system** to minimize noise while maximizing coverage:
67+
68+
| Type | Trigger | Purpose |
69+
| -------------- | ---------------- | ---------------------------------------------------------------------------------------------------------------------------- |
70+
| **Mandates** | `always_on` | Non-negotiable constraints loaded in every session (security, logging, code completion). |
71+
| **Principles** | `model_decision` | Contextual guidance activated only when working on relevant areas (e.g., database rules activate only when writing queries). |
72+
73+
Conflicts between rules are resolved by [Rule Priority](.agent/rules/rule-priority.md) — security always wins.
74+
5775
### Comprehensive Rule Suite
5876

5977
The power of the setup comes from its extensive collection of rules covering every aspect of software engineering.
@@ -66,15 +84,21 @@ The power of the setup comes from its extensive collection of rules covering eve
6684
#### ⚡ Reliability & Performance
6785
* **[Error Handling Principles](.agent/rules/error-handling-principles.md)**: Techniques for robust error management.
6886
* **[Concurrency & Threading](.agent/rules/concurrency-and-threading-principles.md)**: Safe parallel execution and deadlock prevention.
87+
* **[Concurrency & Threading Mandate](.agent/rules/concurrency-and-threading-mandate.md)**: When to use (and not use) concurrency.
6988
* **[Performance Optimization](.agent/rules/performance-optimization-principles.md)**: Writing efficient and scalable code.
7089
* **[Resource Management](.agent/rules/resources-and-memory-management-principles.md)**: Handling memory and system resources responsibly.
90+
* **[Monitoring & Alerting](.agent/rules/monitoring-and-alerting-principles.md)**: Health checks, metrics, and graceful degradation.
91+
* **[Configuration Management](.agent/rules/configuration-management-principles.md)**: Environment variables, secrets, and config hierarchy.
7192

7293
#### 🏗️ Architecture & Design
7394
* **[Core Design Principles](.agent/rules/core-design-principles.md)**: Fundamental software design rules (SOLID, DRY, etc.).
7495
* **[API Design Principles](.agent/rules/api-design-principles.md)**: Creating clean, intuitive, and versionable APIs.
75-
* **[Architectural Pattern](.agent/rules/architectural-pattern.md)**: Guidelines for structuring applications.
96+
* **[Architectural Pattern](.agent/rules/architectural-pattern.md)**: Testability-first design with I/O isolation.
97+
* **[Project Structure](.agent/rules/project-structure.md)**: Feature-based organization (the single source of truth for layout).
98+
* **[Database Design](.agent/rules/database-design-principles.md)**: Schema design, migrations, and query safety.
7699
* **[Data Serialization](.agent/rules/data-serialization-and-interchange-principles.md)**: Safe data handling and formats.
77100
* **[Command Execution](.agent/rules/command-execution-principles.md)**: Principles for running system commands securely.
101+
* **[Avoid Circular Dependencies](.agent/rules/avoid-circular-dependencies.md)**: Preventing module import cycles.
78102

79103
#### 🧩 Maintainability & Quality
80104
* **[Code Organization](.agent/rules/code-organization-principles.md)**: Structuring projects for readability.
@@ -83,32 +107,106 @@ The power of the setup comes from its extensive collection of rules covering eve
83107
* **[Dependency Management](.agent/rules/dependency-management-principles.md)**: Managing external libraries safely.
84108
* **[Documentation Principles](.agent/rules/documentation-principles.md)**: Writing clear and helpful documentation.
85109
* **[Logging & Observability](.agent/rules/logging-and-observability-principles.md)**: Ensuring system visibility.
110+
* **[Logging & Observability Mandate](.agent/rules/logging-and-observability-mandate.md)**: All operations must be logged — no exceptions.
111+
* **[Accessibility Principles](.agent/rules/accessibility-principles.md)**: WCAG 2.1 AA compliance for UIs.
112+
* **[Git Workflow](.agent/rules/git-workflow-principles.md)**: Conventional commits, branch naming, and PR hygiene.
113+
114+
#### 🔄 DevOps & Operations
115+
* **[CI/CD Principles](.agent/rules/ci-cd-principles.md)**: Pipeline design, Docker, and GitHub Actions.
116+
* **[Code Completion Mandate](.agent/rules/code-completion-mandate.md)**: Automated quality checks before every delivery.
117+
* **[Rule Priority](.agent/rules/rule-priority.md)**: Conflict resolution when rules contradict each other.
86118

87119
### Specialized Skills
88120

89121
* **[Debugging Protocol](.agent/skills/debugging-protocol/SKILL.md)**: Systematic approach to solving errors.
90-
* **[Frontend Design](.agent/skills/frontend-design/SKILL.md`)**: Guidelines for creating visually appealing UIs, based on [Antrophic Frontend-Design Skills](https://github.com/anthropics/skills/tree/main/skills/frontend-design)
122+
* **[Frontend Design](.agent/skills/frontend-design/SKILL.md)**: Guidelines for creating visually appealing UIs, based on [Anthropic Frontend-Design Skills](https://github.com/anthropics/skills/tree/main/skills/frontend-design)
123+
* **[Mobile Design](.agent/skills/mobile-design/SKILL.md)**: Production-grade mobile interfaces for Flutter and React Native.
91124
* **[Sequential Thinking](.agent/skills/sequential-thinking/SKILL.md)**: A tool for breaking down complex problems, an adaptation from [Sequential Thinking MCP Server](https://github.com/modelcontextprotocol/servers/tree/main/src/sequentialthinking)
125+
* **[Code Review](.agent/skills/code-review/SKILL.md)**: Structured code review protocol against the full rule set.
126+
* **[Guardrails](.agent/skills/guardrails/SKILL.md)**: Pre-flight checklist and post-implementation self-review.
127+
* **[ADR (Architecture Decision Records)](.agent/skills/adr/SKILL.md)**: Document significant architectural decisions with context and trade-offs.
128+
129+
### Development Workflows
130+
131+
The setup includes opinionated, end-to-end workflows that chain rules and skills into structured development processes.
132+
133+
#### 🏭 Feature Workflow (`/orchestrator`)
134+
135+
The primary workflow for building features. Phases execute sequentially — **no skipping**.
136+
137+
```
138+
Research → Implement (TDD) → Integrate → E2E (conditional) → Verify → Ship
139+
```
140+
141+
| Phase | Workflow | Purpose |
142+
| ------------ | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
143+
| 1. Research | [`/1-research`](.agent/workflows/1-research.md) | Understand context, search docs, create ADRs, uses [Qurio](https://github.com/irahardianto/qurio) default to web search |
144+
| 2. Implement | [`/2-implement`](.agent/workflows/2-implement.md) | TDD cycle: Red → Green → Refactor |
145+
| 3. Integrate | [`/3-integrate`](.agent/workflows/3-integrate.md) | Integration tests with Testcontainers |
146+
| 3.5. E2E | [`/e2e-test`](.agent/workflows/e2e-test.md) | End-to-end validation with Playwright |
147+
| 4. Verify | [`/4-verify`](.agent/workflows/4-verify.md) | Full lint, test, and build validation |
148+
| 5. Ship | [`/5-commit`](.agent/workflows/5-commit.md) | Git commit with conventional format |
149+
150+
#### 🔧 Specialized Workflows
151+
152+
| Workflow | When to Use |
153+
| --------------------------------------------- | ---------------------------------------------------- |
154+
| [`/quick-fix`](.agent/workflows/quick-fix.md) | Bug fixes with known root cause (<50 lines) |
155+
| [`/refactor`](.agent/workflows/refactor.md) | Safely restructure code while preserving behavior |
156+
| [`/audit`](.agent/workflows/audit.md) | Code review and quality inspection (no new features) |
157+
158+
<!-- DIRECTORY STRUCTURE -->
159+
## Directory Structure
160+
161+
```
162+
.agent/
163+
├── rules/ # 30 rules (mandates + principles)
164+
│ ├── rugged-software-constitution.md
165+
│ ├── security-mandate.md
166+
│ ├── rule-priority.md
167+
│ └── ...
168+
├── skills/ # 7 specialized skills
169+
│ ├── debugging-protocol/
170+
│ ├── frontend-design/
171+
│ ├── mobile-design/
172+
│ ├── sequential-thinking/
173+
│ ├── code-review/
174+
│ ├── guardrails/
175+
│ └── adr/
176+
└── workflows/ # 10 development workflows
177+
├── orchestrator.md
178+
├── 1-research.md
179+
├── 2-implement.md
180+
├── 3-integrate.md
181+
├── 4-verify.md
182+
├── 5-commit.md
183+
├── quick-fix.md
184+
├── refactor.md
185+
├── audit.md
186+
└── e2e-test.md
187+
```
92188

93189
<!-- ROADMAP -->
94190
## Roadmap
95191

96-
- [ ] Include more specialized skills to aid development process.
192+
- [x] Include more specialized skills to aid development process (7 skills shipped).
193+
- [x] Add development workflows for structured feature delivery (10 workflows shipped).
97194
- [ ] Add more language-specific security rules (Python, Go, Rust).
98195
- [ ] Create a CLI tool for easier installation (`npx install-antigravity`).
99196
- [ ] Add automated validation scripts to check if an agent is following the constitution.
197+
- [ ] Publish comprehensive documentation site (GitHub Pages).
100198

101199
## Project Adaptation Guide
102200

103201
This setup supports different project structures:
104202

105-
| Project Type | Adaptation |
106-
|-------------|------------|
107-
| **Monorepo** (default) | Use as-is |
108-
| **Single backend** | Remove frontend rules/workflows, keep backend paths |
109-
| **Single frontend** | Remove backend rules/workflows, keep frontend paths |
110-
| **Microservices** | Adapt `project-structure.md` per service, add service mesh rules |
111-
| **Mobile (Flutter/RN)** | Adapt frontend rules, add mobile-specific accessibility/testing |
203+
| Project Type | Adaptation |
204+
| ----------------------- | ---------------------------------------------------------------- |
205+
| **Monorepo** (default) | Use as-is |
206+
| **Single backend** | Remove frontend rules/workflows, keep backend paths |
207+
| **Single frontend** | Remove backend rules/workflows, keep frontend paths |
208+
| **Microservices** | Adapt `project-structure.md` per service, add service mesh rules |
209+
| **Mobile (Flutter/RN)** | Adapt frontend rules, add mobile-specific accessibility/testing |
112210

113211
**To adapt:** Edit `project-structure.md` and `4-verify.md` to match your project layout.
114212

‎github-pages/_config.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
title: Antigravity Setup
2+
description: A rugged, high-quality configuration suite for AI Agents.
3+
remote_theme: just-the-docs/just-the-docs
4+
5+
url: "https://irahardianto.github.io"
6+
baseurl: "/antigravity-setup"
7+
8+
# Enable search
9+
search_enabled: true
10+
search.heading_level: 3
11+
12+
# Aux links (GitHub repo link in the header)
13+
aux_links:
14+
"View on GitHub": "https://github.com/irahardianto/antigravity-setup"
15+
aux_links_new_tab: true
16+
17+
# Footer
18+
footer_content: "Built with ❤️ for the Developer Community. Distributed under the MIT License."
19+
20+
# Navigation
21+
nav_sort: case_insensitive
22+
23+
# Color scheme
24+
color_scheme: dark
25+
26+
# Back to top link
27+
back_to_top: true
28+
back_to_top_text: "Back to top"
29+
30+
# Callouts
31+
callouts:
32+
warning:
33+
title: Warning
34+
color: yellow
35+
note:
36+
title: Note
37+
color: blue
38+
tip:
39+
title: Tip
40+
color: green
41+
important:
42+
title: Important
43+
color: red

0 commit comments

Comments
 (0)