Skip to content

Commit 02deeba

Browse files
committed
Simplify README
1 parent 6351f1f commit 02deeba

File tree

2 files changed

+12
-56
lines changed

2 files changed

+12
-56
lines changed

README.md

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Infrastructure and tooling for AI Engineering bootcamps, providing secure, isola
1414

1515
## Overview
1616

17-
This platform consists of two main components:
17+
This platform consists of the following components:
1818

19-
1. **Coder Deployment** - Containerized development environments on GCP
19+
1. **Coder Deployment** - Containerized development environments supported by [Coder](https://coder.com)
2020
2. **Participant Onboarding System** - Secure, automated participant onboarding
2121

2222
---
@@ -45,10 +45,10 @@ Automated system for securely distributing team-specific API keys to bootcamp pa
4545

4646
### Features
4747

48-
**Secure Authentication** - Firebase custom tokens with per-participant access
49-
**Team Isolation** - Firestore security rules enforce team-level data separation
50-
**Automated Onboarding** - One-command setup for participants
51-
**API Key Management** - Automated generation and distribution of:
48+
- **Secure Authentication** - Firebase custom tokens with per-participant access
49+
- **Team Isolation** - Firestore security rules enforce team-level data separation
50+
- **Automated Onboarding** - One-command setup for participants
51+
- **API Key Management** - Automated generation and distribution of API keys
5252

5353
### Architecture
5454

@@ -72,26 +72,4 @@ Automated system for securely distributing team-specific API keys to bootcamp pa
7272
└─────────────────────────────────────────────────────────────────┘
7373
```
7474

75-
## Requirements
76-
77-
- Python 3.12+
78-
- `uv` package manager
79-
- GCP project with Firestore and Secret Manager enabled
80-
- Firebase project with Authentication enabled
81-
- Appropriate GCP permissions (see admin guide)
82-
83-
## Installation
84-
85-
```bash
86-
# Clone repository
87-
git clone <repository-url>
88-
cd aieng-platform
89-
90-
# Install dependencies
91-
uv sync
92-
93-
# Authenticate with GCP
94-
gcloud auth application-default login
95-
```
96-
9775
---

docs/index.md

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Infrastructure and tooling for AI Engineering bootcamps, providing secure, isola
1414

1515
## Overview
1616

17-
This platform consists of two main components:
17+
This platform consists of the following components:
1818

19-
1. **Coder Deployment** - Containerized development environments on GCP
19+
1. **Coder Deployment** - Containerized development environments supported by [Coder](https://coder.com)
2020
2. **Participant Onboarding System** - Secure, automated participant onboarding
2121

2222
---
@@ -45,10 +45,10 @@ Automated system for securely distributing team-specific API keys to bootcamp pa
4545

4646
### Features
4747

48-
**Secure Authentication** - Firebase custom tokens with per-participant access
49-
**Team Isolation** - Firestore security rules enforce team-level data separation
50-
**Automated Onboarding** - One-command setup for participants
51-
**API Key Management** - Automated generation and distribution of:
48+
- **Secure Authentication** - Firebase custom tokens with per-participant access
49+
- **Team Isolation** - Firestore security rules enforce team-level data separation
50+
- **Automated Onboarding** - One-command setup for participants
51+
- **API Key Management** - Automated generation and distribution of API keys
5252

5353
### Architecture
5454

@@ -72,26 +72,4 @@ Automated system for securely distributing team-specific API keys to bootcamp pa
7272
└─────────────────────────────────────────────────────────────────┘
7373
```
7474

75-
## Requirements
76-
77-
- Python 3.12+
78-
- `uv` package manager
79-
- GCP project with Firestore and Secret Manager enabled
80-
- Firebase project with Authentication enabled
81-
- Appropriate GCP permissions (see admin guide)
82-
83-
## Installation
84-
85-
```bash
86-
# Clone repository
87-
git clone <repository-url>
88-
cd aieng-platform
89-
90-
# Install dependencies
91-
uv sync
92-
93-
# Authenticate with GCP
94-
gcloud auth application-default login
95-
```
96-
9775
---

0 commit comments

Comments
 (0)