Skip to content

Update README with build and start instructions #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hdcodedev merged 2 commits into from
Mar 26, 2026
+4 −15
Merged

Update README with build and start instructions #28

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
723e6d6
Update README with build and start instructions
hdcodedev Mar 26, 2026
ea0150d
Update README with local development instructions
hdcodedev Mar 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 4 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,19 @@

Documentation repository for Charts.

<img width="900" alt="Screenshot 2026-03-26 at 16 07 36" src="https://github.com/user-attachments/assets/be705db8-5c55-42d8-8dd8-57745c44e06e" />


## Repo Layout

- `docs-app/` - Next.js docs website
- `content/` - versioned markdown content
- `registry/versions.json` - version registry used by the site
- static assets for API/demo/playground are served from object storage/CDN via `DOCS_STATIC_BASE_URL`
- static assets for API/demo/playground are served from object storage/CDN

## Local Development

```bash
cd docs-app
npm ci
npm run dev
```

## Build

```bash
cd docs-app
npm run build
npm run start
```

## Notes

- `main` contains docs source and app code.
- Set `DOCS_STATIC_BASE_URL` for local/dev/CI since `/static/*` is always served from CDN.