mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-03 17:27:37 +08:00
c6eebfc25a
Two machine-readable entry points to the Hermes Agent docs:
/llms.txt curated index of every doc page, one link per page
with short descriptions. ~17 KB, safe to load into
an LLM context window.
/llms-full.txt every page under website/docs/ concatenated as markdown.
~1.8 MB. For one-shot ingestion by coding agents and
RAG pipelines.
Both files are also served from /docs/llms.txt and /docs/llms-full.txt
(Docusaurus serves website/static/ under baseUrl=/docs/). Some agents and
IDE plugins probe the classic site-root path; the deploy workflow now copies
both files to _site root so either URL works.
Conforms to the emerging llmstxt.org spec: H1 project name, blockquote
summary, short install command, GitHub link, then curated sections
mirroring the docs-site navigation (Getting Started, Using Hermes,
Features, Messaging, Integrations, Guides, Developer Guide, Reference).
Generated by website/scripts/generate-llms-txt.py. Wired into prebuild.mjs
so every 'npm run build' and 'npm run start' refreshes the files alongside
the existing skills.json extraction. Both outputs are gitignored (same
precedent as src/data/skills.json).
Descriptions in llms.txt are pulled from each page's frontmatter, so they
stay current automatically. All ~80 section slugs are validated against
the filesystem at generation time; an invalid slug would fail the prebuild.
98 lines
2.9 KiB
YAML
98 lines
2.9 KiB
YAML
name: Deploy Site
|
|
|
|
on:
|
|
release:
|
|
types: [published]
|
|
push:
|
|
branches: [main]
|
|
paths:
|
|
- 'website/**'
|
|
- 'skills/**'
|
|
- 'optional-skills/**'
|
|
- '.github/workflows/deploy-site.yml'
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
pages: write
|
|
id-token: write
|
|
|
|
concurrency:
|
|
group: pages
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
deploy-vercel:
|
|
if: github.event_name == 'release'
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Trigger Vercel Deploy
|
|
run: curl -X POST "${{ secrets.VERCEL_DEPLOY_HOOK }}"
|
|
|
|
deploy-docs:
|
|
if: github.repository == 'NousResearch/hermes-agent'
|
|
runs-on: ubuntu-latest
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deploy.outputs.page_url }}
|
|
steps:
|
|
- uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
|
|
|
|
- uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
|
|
with:
|
|
node-version: 20
|
|
cache: npm
|
|
cache-dependency-path: website/package-lock.json
|
|
|
|
- uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
|
|
with:
|
|
python-version: '3.11'
|
|
|
|
- name: Install PyYAML for skill extraction
|
|
run: pip install pyyaml==6.0.2 httpx==0.28.1
|
|
|
|
- name: Extract skill metadata for dashboard
|
|
run: python3 website/scripts/extract-skills.py
|
|
|
|
- name: Regenerate per-skill docs pages + catalogs
|
|
run: python3 website/scripts/generate-skill-docs.py
|
|
|
|
- name: Build skills index (if not already present)
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
run: |
|
|
if [ ! -f website/static/api/skills-index.json ]; then
|
|
python3 scripts/build_skills_index.py || echo "Skills index build failed (non-fatal)"
|
|
fi
|
|
|
|
- name: Install dependencies
|
|
run: npm ci
|
|
working-directory: website
|
|
|
|
- name: Build Docusaurus
|
|
run: npm run build
|
|
working-directory: website
|
|
|
|
- name: Stage deployment
|
|
run: |
|
|
mkdir -p _site/docs
|
|
cp -r website/build/* _site/docs/
|
|
# llms.txt / llms-full.txt are also published at the site root
|
|
# (https://hermes-agent.nousresearch.com/llms.txt) because some
|
|
# agents and IDE plugins probe the classic root-level path rather
|
|
# than /docs/llms.txt. Same file, two URLs, one source of truth.
|
|
if [ -f website/build/llms.txt ]; then
|
|
cp website/build/llms.txt _site/llms.txt
|
|
fi
|
|
if [ -f website/build/llms-full.txt ]; then
|
|
cp website/build/llms-full.txt _site/llms-full.txt
|
|
fi
|
|
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
|
|
with:
|
|
path: _site
|
|
|
|
- name: Deploy to GitHub Pages
|
|
id: deploy
|
|
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4
|