Skip to content

Commit 6a249d1

Browse files
authored
docs: remove undocumented features and fix platform documentation (#106)
* docs: remove undocumented features and fix platform documentation Remove export docs, organization hierarchy references, and PAT-based GitHub auth that don't reflect the actual platform. Simplify git integration to document the OAuth app flow via Secrets Manager. The changes: - Delete export.md (feature doesn't exist) - Rename organizations-and-projects.md → projects.md (remove org hierarchy) - Simplify git integration to document actual OAuth/Secrets Manager flow - Remove "Create an organization" step from first-spec guide - Update nav in zensical.toml * update github integration description with changes introduced in PR #69
1 parent 9a331b4 commit 6a249d1

7 files changed

Lines changed: 50 additions & 173 deletions

File tree

docs/getting-started/first-spec.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,6 @@ Before starting, make sure you have completed the [Setup](setup.md) steps and ca
88

99
Open your deployed application URL (the CloudFront domain from your deployment). Sign in with your Cognito credentials.
1010

11-
## Create an organization
12-
13-
On the home page, choose **New Organization**. Enter a name (for example, "My Team") and a URL slug (for example, "my-team"). Choose **Create**.
14-
15-
Organizations are the top-level container. Each organization has its own projects, members, and settings.
16-
1711
## Create a project
1812

1913
Inside your organization, choose **New Project**. Enter a name and slug. Choose **Create**.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ In the **Review** phase, review agents evaluate the code from two angles (blind
5757

5858
- [Getting Started](getting-started/prerequisites.md) to set up the platform
5959
- [How it works](concepts/index.md) to understand the lifecycle and principles
60-
- [Using the Platform](using-the-platform/organizations-and-projects.md) for day-to-day usage guides
60+
- [Using the Platform](using-the-platform/projects.md) for day-to-day usage guides

docs/using-the-platform/export.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

docs/using-the-platform/git-integration.md

Lines changed: 15 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -2,78 +2,32 @@
22

33
AIDLC Collaborative integrates with GitHub for repository management, issue creation, and status syncing.
44

5-
## Connecting GitHub
5+
## Configure GitHub OAuth
66

7-
There are two ways to connect:
7+
[Create a GitHub **OAuth App**](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) (not a GitHub App — the flow here expects OAuth App semantics). When prompted, use:
88

9-
### Personal access token (PAT)
9+
- **Homepage URL**: `https://$(terraform -chdir=terraform output -raw cloudfront_domain_name)`
10+
- **Authorization callback URL**: `https://$(terraform -chdir=terraform output -raw cloudfront_domain_name)/github/callback`
1011

11-
Set `GITHUB_TOKEN` in your `.env.local` file:
12+
Then store the OAuth App's credentials in the Secrets Manager secret that terraform created (replace `your_github_client_id` and `your_github_client_secret` with the actual values):
1213

1314
```bash
14-
GITHUB_TOKEN=ghp_your_token_here
15+
aws secretsmanager put-secret-value \
16+
--secret-id $(terraform -chdir=terraform output -raw github_oauth_secret_name) \
17+
--secret-string '{"client_id":"your_github_client_id","client_secret":"your_github_client_secret"}'
1518
```
1619

17-
This is the simplest option for local development.
20+
## Selecting a git repo
1821

19-
### OAuth flow
20-
21-
Configure GitHub OAuth credentials in `.env.local`:
22-
23-
```bash
24-
GITHUB_OAUTH_CLIENT_ID=your_client_id
25-
GITHUB_OAUTH_CLIENT_SECRET=your_client_secret
26-
```
27-
28-
Then connect through the Settings page in the UI. The OAuth flow gives per-project token management.
29-
30-
## Adding repositories to a project
31-
32-
1. Navigate to your project page
33-
2. Open the Git section
34-
3. Add a repository by entering its GitHub URL (for example, `https://github.com/owner/repo`)
22+
1. Click "Create new Project" in the project overview screen
23+
2. The platform will check if you're connected to GitHub
24+
3. Select the repository that should back this new project
3525

3626
The repository is cloned into the workspace and becomes available to the LLM assistant and agents.
3727

38-
## Local repositories
39-
40-
You can also link local git repositories on the server machine:
41-
42-
1. Choose **Browse** to open a folder picker
43-
2. Select a folder that contains a `.git` directory
44-
3. The local repo is linked by path (no cloning needed)
45-
4628
Local repos are useful during development when you want agents to work on the same codebase you are working on.
4729

48-
## Spec-scoped repos
49-
50-
You can assign specific repos to a spec. This tells the system:
51-
52-
- Which repos the LLM assistant should focus on
53-
- Which repos the Construction Agent should target
54-
- Where agents should create worktrees
55-
56-
For each spec-repo association, you configure:
57-
58-
- **Base branch** (for example, `main`)
59-
- **Feature branch pattern** (for example, `feature/{specSlug}/{taskSlug}`)
60-
61-
## Pushing tasks as GitHub Issues
62-
63-
After running Inception:
64-
65-
1. Choose **Create Issues** in the sprint view
66-
2. Select the target repository
67-
3. Tasks are created as GitHub Issues
68-
69-
Each issue includes:
70-
71-
- The task title and description
72-
- Acceptance criteria as a checklist
73-
- Test requirements
74-
- Dependencies listed as issue references
75-
- A complexity label (for example, `complexity:M`)
76-
77-
## Syncing issue status
30+
## Reviews
7831

79-
After issues are created, you can sync their status from GitHub. This updates the task status in AIDLC Collaborative based on whether the GitHub issue is open, closed, or has a linked pull request.
32+
The platform will create a pull request once it is finished with the construction phase. You can start a review. The
33+
platform will store review results as a comment on the pull request.

docs/using-the-platform/organizations-and-projects.md

Lines changed: 0 additions & 67 deletions
This file was deleted.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Organizations and Projects
2+
3+
AIDLC Collaborative uses a project based approach to work.
4+
5+
## Projects
6+
7+
A project groups related specs together. It represents a product, service, or feature area.
8+
9+
Each project has:
10+
11+
- A unique slug within the organization
12+
- Members with project-level roles
13+
- Git repository connections
14+
- Specs
15+
16+
### Creating a project
17+
18+
Navigate to your organization and choose **New Project**. Enter a name and slug.
19+
20+
### Project roles
21+
22+
| Role | Can do |
23+
|------|--------|
24+
| **Admin** | Manage project members, settings, and repos |
25+
| **Editor** | Create and edit specs, run inception, start agents |
26+
| **Viewer** | Read-only access to specs and tasks |
27+
28+
### Permission resolution
29+
30+
When a user accesses a project, their effective role is resolved in this order:
31+
32+
1. Check if the user has an explicit project role
33+
2. If not, fall back to their org role (owner/admin become project admin, member gets no access)
34+
3. If neither, access is denied

zensical.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ nav = [
2626
"using-the-platform/running-agents.md",
2727
"using-the-platform/reviewing-work.md",
2828
"using-the-platform/git-integration.md",
29-
"using-the-platform/export.md",
3029
] },
3130
{ "Roadmap" = "roadmap/index.md" },
3231
]

0 commit comments

Comments
 (0)