Skip to content

Commit 1d6b789

Browse files
authored
Merge pull request #23 from FrankBurmo/add-docs-agent
docs: add comprehensive deployment, development, and user guides for …
2 parents 5348879 + f45fcb2 commit 1d6b789

File tree

7 files changed

+2185
-0
lines changed

7 files changed

+2185
-0
lines changed

.github/agents/docs-agent.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: docs_agent
3+
description: Expert technical writer for this project
4+
---
5+
6+
You are an expert technical writer for this project.
7+
8+
## Your role
9+
- You are fluent in Markdown and can read TypeScript code
10+
- You write for a developer audience, focusing on clarity and practical examples
11+
- Your task: read code from `src/` and generate or update documentation in `docs/`
12+
13+
## Project knowledge
14+
- **Tech Stack:** React, TypeScript, Vite, Tailwind CSS
15+
- **File Structure:**
16+
- `src/` – Application source code (you READ from here)
17+
- `docs/` – All documentation (you WRITE to here)
18+
- `tests/` – Unit, Integration, and Playwright tests
19+
20+
## Commands you can use
21+
Build docs: `npm run docs:build` (checks for broken links)
22+
Lint markdown: `npx markdownlint docs/` (validates your work)
23+
24+
## Documentation practices
25+
Be concise, specific, and value dense
26+
Write so that a new developer to this codebase can understand your writing, don’t assume your audience are experts in the topic/area you are writing about.
27+
28+
## Boundaries
29+
-**Always do:** Write new files to `docs/`, follow the style examples, run markdownlint
30+
- ⚠️ **Ask first:** Before modifying existing documents in a major way
31+
- 🚫 **Never do:** Modify code in `src/`, edit config files, commit secrets

docs/README.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# GitHub Copilot Adoption Dashboard - Dokumentasjon
2+
3+
Velkommen til dokumentasjonen for GitHub Copilot Adoption Dashboard. Dette er et klientsidebasert React-dashboard for å visualisere GitHub Copilot enterprise-metrikker via GitHub REST API.
4+
5+
## Oversikt
6+
7+
Dette dashboardet gir en enkel og oversiktlig måte å:
8+
9+
- Hente og vise GitHub Copilot bruksmetrikker for din enterprise
10+
- Visualisere trender over tid med interaktive diagrammer
11+
- Analysere engasjement per programmeringsspråk og editor
12+
- Estimere seteforbruk og aksepteringsrater
13+
14+
## Dokumentasjonsstruktur
15+
16+
### [Brukerveiledning](user-guide.md)
17+
Komplett guide for sluttbrukere som skal bruke dashboardet.
18+
19+
- Komme i gang (token, enterprise)
20+
- Forstå metrikkene
21+
- Tolke grafer og tabeller
22+
- Feilsøking
23+
- Tips og beste praksis
24+
25+
### [Arkitektur](architecture.md)
26+
Detaljert beskrivelse av applikasjonens struktur, dataflyt og tekniske valg.
27+
28+
- Single-page application design
29+
- Komponenthierarki
30+
- State management
31+
- TypeScript type system
32+
33+
### [API Integrasjon](api-integration.md)
34+
Hvordan applikasjonen integrerer med GitHub Copilot Metrics API.
35+
36+
- Autentisering og sikkerhet
37+
- API endpoints og datamodeller
38+
- Dataprosessering og transformasjon
39+
- Feilhåndtering
40+
41+
### [Utviklingsguide](development.md)
42+
Alt du trenger for å komme i gang med lokal utvikling.
43+
44+
- Forutsetninger og installasjon
45+
- Lokalt utviklingsmiljø
46+
- Testing og linting
47+
- Debugging
48+
49+
### [Deployment](deployment.md)
50+
Informasjon om deployment til GitHub Pages og produksjonsbygg.
51+
52+
- GitHub Actions workflow
53+
- Build-prosess
54+
- GitHub Pages konfigurasjon
55+
- Produksjonsoptimalisering
56+
57+
## Rask start
58+
59+
```bash
60+
# Klon repository
61+
git clone https://github.com/FrankBurmo/github-copilot-adoption-dashboard.git
62+
cd github-copilot-adoption-dashboard
63+
64+
# Installer avhengigheter
65+
npm install
66+
67+
# Start utviklingsserver
68+
npm run dev
69+
```
70+
71+
Applikasjonen vil starte på `http://localhost:5173`.
72+
73+
## Live demo
74+
75+
En kjørende versjon av dashboardet er tilgjengelig på:
76+
**https://frankburmo.github.io/github-copilot-adoption-dashboard/**
77+
78+
## Teknologi stack
79+
80+
- **React 19.2** - UI framework
81+
- **TypeScript 5.9** - Type safety
82+
- **Vite 7.2** - Build tool og dev server
83+
- **Chart.js 4.5** - Datavisualisering
84+
- **Vitest 4.0** - Testing framework
85+
86+
## Bidra
87+
88+
Se [Utviklingsguiden](development.md) for informasjon om hvordan du bidrar til prosjektet.
89+
90+
## Lisens
91+
92+
MIT License - se [LICENSE](../LICENSE) filen for detaljer.

0 commit comments

Comments
 (0)