mfahampshire
f648349e82
* Diatixisify! * First pass at Typedoc generation for TS SDK * Remove overview pages * Fix typos and remove codebase references from docs Fix typos across network and developer docs: Quorum, available, cryptosystem, transaction, proportional, Standalone. Remove TODO placeholder from dVPN protocol page. Strip GitHub source links from network docs to decouple documentation from repo structure. * Expand thin landing pages across network and developer docs - Add intro content to network overview, infrastructure, and reference landing pages - Expand developer index with "where to start" guide - Add usage instructions and explanations to all five TS playground pages - Expand WebSocket client page with setup and message format examples * Restructure Rust SDK developer docs - Delete redundant mixnet example, message-helpers, and message-types subpages - Delete client-pool architecture and example subpages (content folded into landing) - Delete tcpproxy troubleshooting (folded into landing page) - Add deprecation notices to TcpProxy pages, pointing to Stream module - Add stream module docs: landing page, architecture, tutorial, and 4 example pages - Add mixnet and client-pool tutorials - Add SDK tour page - Update navigation and landing pages with docs.rs links * Restructure TS SDK developer docs - Merge overview, installation, and getting started into TS SDK landing page - Fold FAQ content into bundling/troubleshooting section - Delete redundant overview, installation, start, and FAQ pages - Update internal links in browsers.mdx and native.mdx - Update navigation and example page imports * Flatten and expand APIs section - Collapse nested API subpages into single pages with inline Redoc embeds - Rewrite introduction as landing page with decision table - Add endpoint categories, quick curl examples to each API page - Mark Explorer API as deprecated - Move NS API deployment guide to operators/performance-and-testing - Fix dangling /apis/nym-api/mainnet link in network-components - Remove sandbox endpoints from all API pages * Add redirects for moved and deleted pages - Add 25 redirects covering TS SDK, Rust SDK, APIs, and network sections - Fix dangling /developers/typescript/start link in operators changelog * Replace individual example doc pages with GitHub-linked tables, expand tutorials - replace individual example doc pages with GitHub-linked tables - expand mixnet tutorial with persistent identity and split_sender sections - add tcpproxy tutorial - rename "API Reference" to "TypeDoc Reference" in TS SDK sidebar - rename "Misc" to "Extras" in developer sidebar, move VPN CLI up - remove echo server from tools - update message-queue callout to reference actual modules - fix mixnet/examples redirect collision * Add SEO frontmatter, validate encryption standards, clean up URLs - add title/description/schemaType/section/lastUpdated frontmatter to 48 pages across developers, network, and APIs sections - remove network/.archive/ directory (compare against develop instead) - update nymtech.net → nym.com for website/blog links (keep infra URLs) - add native proxy "in progress" callout for Rust/C/Go * API-scraper update (#6598) * read nodes and locations * update python-prebuild.sh * Address PR #6494 review feedback - Use "mode" consistently instead of "role" on nym-nodes page - Replace "staking" with "bonding" for NYM token collateral - Wire up auto-scraped node counts via TimeNow + nodes-count.json - Fix broken licensing images: download CC icons locally, replace inline HTML - Fix 9 stale redirects pointing through deleted /network/architecture path * Fix linkcheck errors - Fix stale cross-links: /network/concepts/ → /network/mixnet-mode/ - Replace README.md references with globals.md in TypeDoc output - Add entryFileName: globals to typedoc.json configs to prevent recurrence * Fix remaining stale /network/architecture links - zk-nym-overview: architecture/nyx#nym-api → /network/infrastructure/nyx#nym-api - setup: network/architecture → /network/overview * Remove accidentally re-included architecture.md file from rebase * Standardize tutorials, document examples, add llms.txt, apply tone fixes - Expand Rust SDK tutorials with step-by-step structure; document all SDK examples across mixnet, client-pool, and tcpproxy pages - Add llms.txt generation script, wire into build and CI workflows - Apply tone/style fixes: deduplicate callouts, vary sentence structure, standardize voice consistency across changed pages * Consolidate redundant network overview docs * Trim dev docs: git-first imports, stream notice, collapse TcpProxy * Update tutorial * Refresh auto-generated API and command outputs * Update network section docs * Update developer and API docs: reusable components, stream protocol, conventions, tutorial fixes * Fix Rust SDK tutorial bugs: setup_env, port conflicts, logging, open_stream race condition * Update stream.mdx * Remove docs.rs link from Stream overview for the moment * add llms.txt and llms-full.txt note to readme --------- Co-authored-by: import this <97586125+serinko@users.noreply.github.com>
93 lines
3.3 KiB
YAML
93 lines
3.3 KiB
YAML
name: cd-docs
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: arc-ubuntu-22.04
|
|
env:
|
|
NEXT_PUBLIC_SITE_URL: https://nym.com/docs
|
|
defaults:
|
|
run:
|
|
working-directory: documentation/docs
|
|
steps:
|
|
- uses: actions/checkout@v6
|
|
- name: Install Dependencies (Linux)
|
|
run: sudo apt-get update && sudo apt-get install -y build-essential curl wget libssl-dev libudev-dev squashfs-tools protobuf-compiler git python3 && sudo apt-get update --fix-missing
|
|
- name: Install Python3 modules
|
|
run: sudo apt install -y python3-pandas python3-tabulate
|
|
- name: Install rsync
|
|
run: sudo apt-get install -y rsync
|
|
- uses: rlespinasse/github-slug-action@v3.x
|
|
- name: Setup pnpm
|
|
uses: pnpm/action-setup@v4.2.0
|
|
with:
|
|
version: 9
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 20
|
|
- name: Install Rust toolchain
|
|
uses: actions-rs/toolchain@v1
|
|
with:
|
|
toolchain: ${{ vars.REQUIRED_RUSTC_VERSION }}
|
|
- name: Build all binaries
|
|
uses: actions-rs/cargo@v1
|
|
with:
|
|
command: build
|
|
args: --workspace --release
|
|
|
|
- name: Install project dependencies
|
|
run: pnpm i
|
|
- name: Generate llms-full.txt
|
|
run: pnpm run generate:llms
|
|
- name: Build project
|
|
run: pnpm run build
|
|
- name: Generate sitemap
|
|
run: npx next-sitemap
|
|
- name: Move files to /dist/
|
|
run: ../scripts/move-to-dist.sh
|
|
|
|
- name: Create Vercel project file
|
|
uses: mobiledevops/secret-to-file-action@v1
|
|
with:
|
|
base64-encoded-secret: ${{ secrets.VERCEL_PROJECT_JSON_BASE64 }}
|
|
filename: "project.json"
|
|
is-executable: true
|
|
working-directory: "./dist/docs/.vercel"
|
|
|
|
- name: Install Vercel CLI
|
|
run: npm install --global vercel@latest
|
|
continue-on-error: false
|
|
|
|
- name: Pull Vercel Environment Information (preview)
|
|
if: github.ref != 'refs/heads/master'
|
|
run: vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}
|
|
working-directory: dist/docs
|
|
- name: Pull Vercel Environment Information (production)
|
|
if: github.ref == 'refs/heads/master'
|
|
run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
|
|
working-directory: dist/docs
|
|
continue-on-error: false
|
|
|
|
- name: Build Project Artifacts (preview)
|
|
if: github.ref != 'refs/heads/master'
|
|
run: vercel build --token=${{ secrets.VERCEL_TOKEN }}
|
|
working-directory: dist/docs
|
|
continue-on-error: false
|
|
- name: Build Project Artifacts (production)
|
|
if: github.ref == 'refs/heads/master'
|
|
run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
|
|
working-directory: dist/docs
|
|
continue-on-error: false
|
|
|
|
- name: Deploy Project Artifacts to Vercel (preview)
|
|
if: github.ref != 'refs/heads/master'
|
|
run: vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }}
|
|
working-directory: dist/docs
|
|
- name: Deploy Project Artifacts to Vercel (master)
|
|
if: github.ref == 'refs/heads/master'
|
|
run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}
|
|
working-directory: dist/docs
|
|
continue-on-error: false
|