Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 0 additions & 22 deletions .codesandbox/tasks.json

This file was deleted.

19 changes: 0 additions & 19 deletions .devcontainer/Dockerfile

This file was deleted.

5 changes: 0 additions & 5 deletions .devcontainer/devcontainer.json

This file was deleted.

112 changes: 112 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
## Purpose

This file gives concise, repository-specific guidance to an AI coding agent so it can be productive working on the Docusaurus documentation site in this repo.

## Big picture

- This project is a Docusaurus site (see `docusaurus.config.js`) using the classic preset. Main content lives under `docs/` and `blog/`. React UI code is in `src/` and static assets in `static/`.
- Primary responsibilities: serve the site locally, author docs/blog posts (Markdown/MDX), update UI components and styles, and build/deploy the static site.

## Important files & folders (examples)

- `package.json` — contains npm/yarn scripts used to run, build, and deploy the site (see `start`, `build`, `deploy`).
- `docusaurus.config.js` — global config: `baseUrl`, `organizationName`, `projectName`, i18n, theme, navbar/footer.
- `sidebars.js` — docs sidebar configuration. When changing doc structure, update this file.
- `docs/` — documentation pages. Subfolders use `_category_.json` for grouping (example: `tutorial-basics/_category_.json`).
- `blog/` — blog posts (Markdown/MDX) and metadata files `authors.yml`, `tags.yml`.
- `src/components/` — custom React components used by pages (example: `src/components/HomepageFeatures/index.js`).
- `static/img/` and `docs/**/img/` — image assets referenced by docs/blog.

## Development commands (explicit)

Run locally (recommended, project README uses yarn):
## Purpose

This file gives concise, repository-specific guidance to an AI coding agent so it can be productive working on this Docusaurus documentation site.

## Big picture

- This repo is a Docusaurus v3 site (see `docusaurus.config.js`) using the classic preset. Content is split into `docs/` (documentation) and `blog/` (posts). React UI code lives in `src/` and static assets in `static/`.
- Primary agent responsibilities: run the dev server, add/edit docs & blog posts (MD/MDX), update UI components/styles, manage sidebar and category metadata, build and deploy the site.

## Key files & folders

- `package.json` — scripts: `start` (dev), `build` (prod), `serve` (serve build), `deploy` (GitHub Pages). Node >= 20 is required (check `engines`).
- `docusaurus.config.js` — global site config (baseUrl, organizationName, projectName, editUrl, navbar/footer). Verify `organizationName` / `projectName` before changing deploy targets.
- `sidebars.js` — controls docs sidebar. Adding/moving docs often requires updating this file or the sidebar path used by the config.
- `docs/` — markdown/MDX docs. Subfolders use `_category_.json` for grouping (see `docs/tutorial-basics/_category_.json`).
- `blog/` — posts (MD/MDX) and metadata: `authors.yml`, `tags.yml`. Example: `blog/2021-08-01-mdx-blog-post.mdx`.
- `src/components/` — React UI components used by pages (example: `src/components/HomepageFeatures/index.js`).
- `src/css/custom.css` — global styling. Page-specific modules exist under `src/pages`.
- `static/img/` and `docs/**/img/` — image assets. Use `static/img/` for global assets and relative `./img/...` inside docs for doc-scoped images.

## Quick start (Windows / PowerShell)

1. Install dependencies:

```powershell
yarn
```

2. Run dev server (hot reload; default port 3000):

```powershell
yarn start
```

3. Build and preview production:

```powershell
yarn build
yarn serve
```

4. Deploy to GitHub Pages (as provided in repo):

```powershell
USE_SSH=true; yarn deploy
# or without SSH
GIT_USER=<your-username>; yarn deploy
```

If you prefer npm, replace `yarn` with `npm run` for the named scripts.

## Project-specific conventions & patterns

- Docs grouping: each docs subfolder may include `_category_.json` that the site relies on. Don't rename or remove them without updating `sidebars.js`.
- Images: place global images in `static/img/` and per-doc images in a `img/` folder next to the doc file; reference via `./img/foo.png` in Markdown.
- UI: small reusable components live in `src/components/`. Use existing styles in `src/css/custom.css` and `src/components/*/styles.module.css` patterns.
- MDX usage: examples exist in `docs/` and `blog/` — prefer MDX when embedding React components inside docs.

## Integration points & external dependencies

- Docusaurus packages (check `package.json`): primary runtime. Avoid adding heavy runtime-only dependencies unless necessary for docs.
- GitHub Pages is the default deploy target (deploy script present). Confirm `docusaurus.config.js` `organizationName` and `projectName` match the repo/org before changing `editUrl` or deploy settings.
- No CI configuration was found in the repo root. If you add CI (GitHub Actions), ensure Node >= 20 and `yarn install && yarn build` steps.

## Concrete examples (what to change and where)

- Add a doc: create `docs/<section>/new-doc.md` (or `.mdx`) and add/update `sidebars.js` or rely on the configured automatic sidebar path.
- Add blog post: `blog/YYYY-MM-DD-title.md` with YAML frontmatter (title, tags, authors). Update `blog/authors.yml` for new authors.
- Edit homepage features: modify `src/components/HomepageFeatures/index.js` and `src/components/HomepageFeatures/styles.module.css`, then `yarn start` to hot-reload.

## Notes & watch-outs

- Docusaurus config runs in Node (no browser globals). Keep dynamic code safe for Node execution.
- The repo uses Docusaurus v3 with `future.v4: true` — upgrading to v4 may require breaking changes; test locally.
- Verify `organizationName` / `projectName` in `docusaurus.config.js` before deploying.
- There are no automated tests found in the repo — treat code edits accordingly and do a local build verification (`yarn build && yarn serve`).

## When editing/PR guidance for an AI agent

- Make one small, testable change per PR (e.g., add a doc, update a component). Run `yarn start` or `yarn build` locally to validate.
- Update `sidebars.js` or the relevant `_category_.json` if moving docs between folders.
- For visual changes, include screenshots in the PR description and the `build/` output when applicable.

## Contact / Maintainer questions

- Confirm values for `organizationName` and `projectName` in `docusaurus.config.js` if you plan to change deploy settings.
- If you want CI configuration or GitHub Actions templates, specify Node version and preferred publish flow.

---
If you'd like, I can: (a) add a small GitHub Actions workflow that runs `yarn build` on PRs, or (b) generate a short CONTRIBUTING.md with doc/post guidelines—tell me which and I'll implement it.
36 changes: 36 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: CI

on:
pull_request:
# run on PRs targeting main branches used in this repo
branches:
- dev
- docusaurus
- main
workflow_dispatch: {}

jobs:
build:
name: Build site
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'yarn'

- name: Install dependencies
run: yarn install --frozen-lockfile

- name: Build site
run: yarn build

- name: Upload build artifact
uses: actions/upload-artifact@v4
with:
name: site-build
path: build
26 changes: 20 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
.env
.netlify
.hugo_build.lock
node_modules
public
resources
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
13 changes: 0 additions & 13 deletions .gitpod.yml

This file was deleted.

2 changes: 0 additions & 2 deletions .npmignore

This file was deleted.

4 changes: 0 additions & 4 deletions .npmrc

This file was deleted.

12 changes: 0 additions & 12 deletions .prettierignore

This file was deleted.

19 changes: 0 additions & 19 deletions .prettierrc.yaml

This file was deleted.

3 changes: 0 additions & 3 deletions .vscode/extensions.json

This file was deleted.

7 changes: 0 additions & 7 deletions .vscode/settings.json

This file was deleted.

21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

## Installation

```bash
yarn
```

## Local Development

```bash
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Build

```bash
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

Using SSH:

```bash
USE_SSH=true yarn deploy
```

Not using SSH:

```bash
GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
Binary file removed assets/favicon.png
Binary file not shown.
1 change: 0 additions & 1 deletion assets/favicon.svg

This file was deleted.

1 change: 0 additions & 1 deletion assets/js/custom.js

This file was deleted.

Loading
Loading