Skip to content

Commit 0827b31

Browse files
committed
docs: Comprehensive documentation update for PDP-only architecture
- Completely rewrote README.md (1585 lines → ~400 lines) - Removed all pipeline processing documentation (moved to g119612) - Updated to reflect --etsi-cert-bundle and --etsi-tsl-files options - Added clear note about tsl-tool for pipeline processing - Streamlined architecture and deployment sections - Updated DEVELOPER.md - Removed pipeline-related examples and commands - Updated build output name references - Changed coverage targets from pipeline to registry packages - Marked ADRs 0001, 0003, 0004 as Superseded - Pipeline architecture, concurrent processing, and XSLT - Added notes pointing to g119612 for current implementation - Archived outdated documentation in docs/archive/ - ARCHITECTURE_SEPARATION_ANALYSIS.md - CMD_TESTING_SUMMARY.md - IMPROVEMENT_PLAN.md - PHASE2_COMPLETION_REPORT.md - PHASE2_REVIEW.md - Updated example/README.md - Simplified to focus on Go code examples - Removed YAML pipeline configuration examples
1 parent ae5643b commit 0827b31

12 files changed

+276
-1546
lines changed

DEVELOPER.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,15 @@ make test
3030
# Build the binary
3131
make build
3232

33-
# Run the server
34-
./gt --pipeline examples/pipeline.yaml
33+
# Run the server (with test certificate bundle)
34+
./go-trust --etsi-cert-bundle /path/to/certs.pem
3535
```
3636

3737
## Development Environment
3838

3939
### Requirements
4040

4141
- **Go**: Version specified in `go.mod` (check with `make check-go-version`)
42-
- **CGO**: Must be enabled (`CGO_ENABLED=1`)
4342
- **Git**: For version control and hooks
4443

4544
### One-Time Setup
@@ -78,7 +77,7 @@ go mod download
7877
### Building
7978

8079
```bash
81-
make build # Build the binary (output: ./gt)
80+
make build # Build the binary (output: ./go-trust)
8281
make install # Install to $GOPATH/bin
8382
make clean # Remove build artifacts
8483
```
@@ -194,7 +193,7 @@ func TestMyFunction_WithValidInput(t *testing.T) {
194193
### Coverage Goals
195194

196195
- **Overall**: >80%
197-
- **Critical packages** (api, pipeline, dsig): >85%
196+
- **Critical packages** (api, registry, authzen): >85%
198197
- Run `make check-coverage` to verify
199198

200199
## Code Quality
@@ -342,10 +341,10 @@ Press `F5` to start debugging with the default configuration.
342341

343342
```bash
344343
# Build with debug symbols
345-
go build -gcflags="all=-N -l" -o gt-debug ./cmd
344+
go build -gcflags="all=-N -l" -o go-trust-debug ./cmd/go-trust
346345

347346
# Run with delve
348-
dlv exec ./gt-debug -- --pipeline examples/pipeline.yaml --log-level debug
347+
dlv exec ./go-trust-debug -- --etsi-cert-bundle /path/to/certs.pem --log-level debug
349348
```
350349

351350
### Logging
@@ -414,12 +413,13 @@ go tool pprof mem.prof
414413
4. Update API documentation in `cmd/main.go`
415414
5. Consider metrics (if appropriate)
416415

417-
### Adding a New Pipeline Function
416+
### Adding a New Registry Type
418417

419-
1. Create function in `pkg/pipeline/`
420-
2. Register in `pipeline.go`
418+
1. Create registry in `pkg/registry/yourregistry/`
419+
2. Implement `TrustRegistry` interface
421420
3. Add tests
422-
4. Update documentation
421+
4. Register in main.go
422+
5. Update documentation
423423

424424
### Updating Dependencies
425425

0 commit comments

Comments
 (0)