Skip to content

Commit 55b3d9b

Browse files
committed
chore: migrate documentation from website/ to docs/ directory
- Update .gitignore to reflect new docs directory structure. - Modify CONTRIBUTING.md and README.md to point to the new docs location. - Adjust GitHub workflows for Docusaurus build and deployment to use the docs directory. - Remove old website files including package.json, package-lock.json, and docusaurus.config.js. - Update references in various files to ensure consistency with the new documentation structure.
1 parent 10781f4 commit 55b3d9b

260 files changed

Lines changed: 8 additions & 44059 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/docs-deploy.yml

Lines changed: 0 additions & 74 deletions
This file was deleted.
Lines changed: 3 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# When you push a version tag (e.g. v1.6.0), create a GitHub Release, push versioned docs to main, and publish to PyPI.
2-
# Note: Creating a release with GITHUB_TOKEN does NOT trigger other workflows, so we run versioned-docs and PyPI here.
1+
# When you push a version tag (e.g. v1.6.0), create a GitHub Release and publish to PyPI.
2+
# Note: Creating a release with GITHUB_TOKEN does NOT trigger other workflows.
3+
# Docs versioning and deploy live in the docs repo.
34
#
45
# Usage:
56
# git tag v1.6.0
@@ -52,48 +53,4 @@ jobs:
5253
env:
5354
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5455

55-
push-version-docs:
56-
needs: release
57-
runs-on: ubuntu-latest
58-
permissions:
59-
contents: write
60-
steps:
61-
- name: Checkout main
62-
uses: actions/checkout@v4
63-
with:
64-
ref: main
65-
fetch-depth: 0
66-
67-
- name: Set up Node
68-
uses: actions/setup-node@v4
69-
with:
70-
node-version: "20"
71-
cache: "npm"
72-
cache-dependency-path: website/package-lock.json
73-
74-
- name: Get version from tag
75-
id: version
76-
run: |
77-
V="${GITHUB_REF#refs/tags/v}"
78-
echo "version=$V" >> $GITHUB_OUTPUT
79-
80-
- name: Install and add docs version
81-
run: |
82-
cd website
83-
npm ci
84-
V="${{ steps.version.outputs.version }}"
85-
if [ -d "versioned_docs/version-$V" ]; then
86-
echo "Docs version $V already exists, skipping."
87-
else
88-
npx docusaurus docs:version "$V"
89-
fi
90-
91-
- name: Push versioned docs to main
92-
run: |
93-
git config user.name "github-actions[bot]"
94-
git config user.email "github-actions[bot]@users.noreply.github.com"
95-
git add website/versioned_docs website/versioned_sidebars website/versions.json
96-
git diff --staged --quiet || git commit -m "chore(docs): add version ${{ steps.version.outputs.version }}"
97-
git push origin HEAD:main
98-
9956

.gitignore

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,6 @@ examples/output/
3333
# MkDocs build output
3434
site/
3535

36-
# Docusaurus (website/)
37-
website/node_modules/
38-
website/build/
39-
website/.docusaurus/
40-
website/.cache/
41-
4236
# System
4337
.DS_Store
4438
Thumbs.db

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Run a subset: `uv run python -m pytest tests/test_swarm.py -v`. Version-specific
3636

3737
- Keep PRs focused (one feature or fix when possible).
3838
- Ensure all tests pass and lint/format checks succeed.
39-
- Update docs in `website/docs/` if you change user-facing behavior or add features (site: [docs.devsper.com](https://docs.devsper.com)).
39+
- Update docs in the **docs** repo if you change user-facing behavior or add features (site: [docs.devsper.com](https://docs.devsper.com)).
4040
- For new tools or providers, add a short note in the relevant doc (e.g. [tools](https://docs.devsper.com/docs/tools), [providers](https://docs.devsper.com/docs/providers)).
4141

4242
## Adding tools or features

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Outputs under `examples/output/`. Run from project root when using script paths.
246246

247247
## Documentation
248248

249-
Full docs (with versioning and dark mode): **[docs.devsper.com](https://docs.devsper.com)**. Source lives in `website/docs/` and is built with [Docusaurus](https://docusaurus.io).
249+
Full docs (with versioning and dark mode): **[docs.devsper.com](https://docs.devsper.com)**. Source and deploy live in the **docs** repo.
250250

251251
| Doc | Description |
252252
|-----|-------------|

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
The documentation site is built with [Docusaurus](https://docusaurus.io) and deployed at **https://docs.devsper.com**.
44

5-
- **Source:** `website/docs/` in this repo
6-
- **Local dev:** From repo root run `cd website && npm install && npm run start`
7-
- **Build:** `cd website && npm run build`
5+
- **Source and deploy:** the **docs** repo (Docusaurus site; CI and deploy live there).
6+
- **Local dev:** In the docs repo run `npm install && npm run start`.
7+
- **Build:** In the docs repo run `npm run build`.
88

99
The table in the main [README](../README.md) links to the deployed docs.

0 commit comments

Comments
 (0)