This repository contains the FeverTokens documentation site built with Docusaurus. The published site highlights the Fever CLI manuals—covering installation, getting-started workflows, advanced guides, and troubleshooting—accessible from the /cli routes.
The content in docs/ is currently organized around the Fever CLI:
docs/CLI/intro.mdintroduces the CLI, highlights key features like declarative manifests and deterministic deployments, and clarifies who benefits from the tool.docs/CLI/installation.mdwalks through npm-based installation, version requirements, verification commands, and common permission fixes.docs/CLI/getting-started.mdcovers authenticating, selecting projects, compiling Solidity sources, and inspecting artifact status.docs/CLI/commands/index.mdprovides an overview of available commands, with detailed pages such asapply.md,compile.md,networks.md,node.md,projects.md,artifacts.md,auth.md,wallets.md, andinstall.mdunderdocs/CLI/commands/.docs/CLI/advanced-usage.mdexplains advanced features including manifest structure, CREATE2 deployments, and Diamond application support.docs/CLI/configuration.mddocuments environment variables, project network files, and global CLI settings.docs/CLI/troubleshooting.mdcatalogues solutions for installation, authentication, compilation, deployment, and artifact sync issues.
- Node.js
>=20 - npm
>=9
npm installnpm run startThe local dev server opens at http://localhost:3000. The homepage immediately redirects to the CLI introduction (/cli/intro) so you can validate the onboarding journey in the same way users will.
npm run buildStatic assets are generated in the build/ directory. To preview the production output locally run:
npm run servenpm run deployConfigure the usual Docusaurus environment variables (USE_SSH, GIT_USER, etc.) depending on how you publish the site.
- CLI guides live under
docs/CLI/, with subdirectories (likecommands/) matching the sidebar grouping. - The sidebar definition is in
sidebars.tsand the navbar configuration indocusaurus.config.ts. - Use
npm run buildbefore opening a PR to catch broken links and frontmatter issues early.
This project is licensed under the Apache License 2.0.