Skip to content
This repository was archived by the owner on Jul 29, 2026. It is now read-only.

Commit d6145e5

Browse files
authored
Merge pull request #2 from KooshaPari/org-github/feat/docs-site
feat(docs): add organization docs site skeleton
2 parents 2b01a75 + 31d342f commit d6145e5

10 files changed

Lines changed: 2643 additions & 0 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Deploy docs
2+
on: { push: { branches: [ main, master ] } }
3+
4+
permissions:
5+
contents: write
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-24.04
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: actions/setup-node@v4
13+
with:
14+
node-version: '20'
15+
cache: npm
16+
- run: npm ci
17+
- run: npm run docs:build
18+
- uses: peaceiris/actions-gh-pages@v4
19+
with: { github_token: ${{ secrets.GITHUB_TOKEN }}, publish_dir: ./docs/.vitepress/dist }

PLAN.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# org-github Plan
2+
3+
## Overview
4+
Reusable workflows and templates for Phenotype ecosystem.
5+
6+
## Phases
7+
8+
### Phase 1: CI Workflows (1 week)
9+
- Rust CI workflow
10+
- Python CI workflow
11+
- TypeScript CI workflow
12+
13+
### Phase 2: Advanced Workflows (2 weeks)
14+
- Security scanning workflow
15+
- Package publishing workflow
16+
- Release creation workflow
17+
18+
### Phase 3: Templates (1 week)
19+
- Issue templates
20+
- PR templates
21+
- Contributing guidelines
22+
23+
## Deliverables
24+
- 4 reusable CI workflows
25+
- Security scanning pipeline
26+
- Multi-registry publishing
27+
- Issue and PR templates

SPEC.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# org-github Specification
2+
3+
## Architecture
4+
```
5+
┌─────────────────────────────────────────────────────┐
6+
│ org-github (GitHub Org Templates) │
7+
├─────────────────────────────────────────────────────┤
8+
│ ┌───────────────────────────────────────────────┐ │
9+
│ │ Repository Templates │ │
10+
│ │ ┌─────────────┐ ┌────────────────────────┐ │ │
11+
│ │ │ ISSUE_TEMPLATE│ │ PULL_REQUEST_TEMPLATE │ │ │
12+
│ │ └─────────────┘ └────────────────────────┘ │ │
13+
│ │ ┌─────────────┐ ┌────────────────────────┐ │ │
14+
│ │ │ docs/ │ │ CODE_OF_CONDUCT.md │ │ │
15+
│ │ └─────────────┘ └────────────────────────┘ │ │
16+
│ └───────────────────────────────────────────────┘ │
17+
└─────────────────────────────────────────────────────┘
18+
```
19+
20+
## Templates
21+
22+
| Template | Purpose |
23+
|----------|---------|
24+
| ISSUE_TEMPLATE | Bug/feature report |
25+
| PULL_REQUEST_TEMPLATE | PR description |
26+
| CODE_OF_CONDUCT.md | Community guidelines |
27+
| CONTRIBUTING.md | Contribution guide |
28+
| FUNDING.yml | Funding options |
29+
30+
## Data Models
31+
32+
```yaml
33+
issue:
34+
type: bug | feature
35+
priority: critical | high | medium | low
36+
area: api | docs | infra
37+
38+
pr:
39+
type: feat | fix | refactor | docs
40+
scope: none | breaking
41+
```

docs/.vitepress/config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export default { title: "Documentation", themeConfig: { nav: [{ text: 'Guide', link: '/guide/' }] } };

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Documentation
3+
---
4+
5+
# Getting started
6+
7+
This repo now has a VitePress documentation skeleton.

docs/journeys/core-integration.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
layout: doc
3+
title: Core Integration
4+
---
5+
6+
# Core Integration
7+
8+
This journey is reserved for the organization profile documentation integration path.
9+
10+
## Status
11+
12+
Planned.

docs/journeys/production-setup.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
layout: doc
3+
title: Production Setup
4+
---
5+
6+
# Production Setup
7+
8+
This journey is reserved for the production documentation publishing path.
9+
10+
## Status
11+
12+
Planned.

docs/stories/integration.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
layout: doc
3+
title: Integration
4+
---
5+
6+
# Integration
7+
8+
This story is reserved for an end-to-end organization documentation integration example.
9+
10+
## Status
11+
12+
Planned.

0 commit comments

Comments
 (0)