How ipfs/ipfs-docs works
Project type and purpose
• This repository is the IPFS documentation site, a static-site application built with VuePress.
• Its sole purpose is to transform Markdown content and assets into a published docs website (https://docs.ipfs.tech), with an automated CI/CD pipeline and some code-generation tooling for API docs.
File structure
• Top-level sources:
• docs/ – all Markdown content plus VuePress config under docs/.vuepress/.
• images/ – static assets used in headers and case studies.
• tools/http-api-docs/ – a Go-based code-generation utility to produce HTTP API reference from annotated endpoints.
• Configuration & scripts:
• package.json / package-lock.json – Node.js dependencies, dev scripts (npm start, npm run build).
• .github/workflows/ and .github/actions/ – GitHub Actions workflows and custom actions for tasks like “update with latest versions,” “latest-kubo-tag,” CI linting, building, deploying.
• docs/.vuepress/config.js, head.js, nav/ – VuePress site configuration, theming, plugin hooks.
• Linting and style:
• .markdownlint.jsonc / .vale.ini – enforce markdown/style rules.
• Dependabot and other automation configs under .github/.
README for additional insights
• Confirms use of VuePress as the static-site generator.
• Describes local dev (npm start -> localhost:8080) and troubleshooting, plus guidelines on CI/CD deploying to Fleek and tests run by CircleCI / GitHub Actions.