mirror of
https://github.com/bybrooklyn/alchemist.git
synced 2026-04-18 01:43:34 -04:00
Move Docusaurus docs site into docs/ subdirectory
Relocates the entire Docusaurus site from the repo root into a dedicated docs/ directory to keep docs tooling separate from the Rust/frontend workspace. Updates CI workflows (build.yml, docs.yml), justfile (adds `just docs` task), and GEMINI.md to reflect the new paths. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
8
.github/workflows/build.yml
vendored
8
.github/workflows/build.yml
vendored
@@ -77,7 +77,7 @@ jobs:
|
||||
bun-docs-${{ runner.os }}-
|
||||
|
||||
- name: Install docs dependencies
|
||||
run: bun install --frozen-lockfile
|
||||
run: cd docs && bun install --frozen-lockfile
|
||||
|
||||
- name: Read VERSION
|
||||
id: ver
|
||||
@@ -87,15 +87,15 @@ jobs:
|
||||
echo "version=${base}${{ inputs.version_suffix }}" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Build docs site
|
||||
run: bun run build
|
||||
run: cd docs && bun run build
|
||||
|
||||
- name: Package docs site
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
ARCHIVE="alchemist-website-${{ steps.ver.outputs.version }}.zip"
|
||||
cd build
|
||||
zip -r "../${ARCHIVE}" .
|
||||
cd docs/build
|
||||
zip -r "../../${ARCHIVE}" .
|
||||
|
||||
- name: Upload docs artifact
|
||||
uses: actions/upload-artifact@v7
|
||||
|
||||
3
.github/workflows/docs.yml
vendored
3
.github/workflows/docs.yml
vendored
@@ -62,7 +62,7 @@ jobs:
|
||||
path: |
|
||||
node_modules
|
||||
~/.bun/install/cache
|
||||
key: bun-docs-${{ runner.os }}-${{ hashFiles('bun.lock') }}
|
||||
key: bun-docs-${{ runner.os }}-${{ hashFiles('docs/bun.lock') }}
|
||||
restore-keys: |
|
||||
bun-docs-${{ runner.os }}-
|
||||
|
||||
@@ -99,3 +99,4 @@ jobs:
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v5
|
||||
s: actions/deploy-pages@v5
|
||||
|
||||
@@ -7,7 +7,7 @@ Alchemist is a media transcoding tool designed for simplicity and space-saving.
|
||||
- **Purpose:** Automated media transcoding and library management to save storage space.
|
||||
- **Backend:** Rust 2024 (Tokio, Axum 0.7, SQLx 0.8 with SQLite).
|
||||
- **Frontend:** Astro 5, React 18, Tailwind CSS (embedded in the Rust binary via `rust-embed`).
|
||||
- **Documentation:** Docusaurus 3.9 (located in the root `package.json`).
|
||||
- **Documentation:** Docusaurus 3.9 (located in `docs/package.json`).
|
||||
- **Core Technologies:** FFmpeg (analyzer and executor), SQLite (state management), Argon2 (security).
|
||||
|
||||
## Architecture & Pipeline
|
||||
|
||||
0
bun.lock → docs/bun.lock
generated
0
bun.lock → docs/bun.lock
generated
@@ -39,7 +39,7 @@ const config: Config = {
|
||||
docs: {
|
||||
routeBasePath: '/',
|
||||
sidebarPath: './sidebars.ts',
|
||||
editUrl: 'https://github.com/bybrooklyn/alchemist/edit/main/website/',
|
||||
editUrl: 'https://github.com/bybrooklyn/alchemist/edit/main/docs/',
|
||||
},
|
||||
pages: false,
|
||||
blog: false,
|
||||
|
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 85 KiB |
4
justfile
4
justfile
@@ -35,6 +35,10 @@ run:
|
||||
web:
|
||||
cd web && bun install --frozen-lockfile && bun run dev
|
||||
|
||||
# Start documentation dev server only
|
||||
docs:
|
||||
cd docs && bun install --frozen-lockfile && bun run start
|
||||
|
||||
# ─────────────────────────────────────────
|
||||
# BUILD
|
||||
# ─────────────────────────────────────────
|
||||
|
||||
Reference in New Issue
Block a user