Skip to content

README.md

Latest commit

 

History

History
100 lines (70 loc) · 2.59 KB

README.md

File metadata and controls

100 lines (70 loc) · 2.59 KB

WAVS Docs

Welcome to the official documentation for WAVS, a WASI AVS runtime for streamlined AVS development.

Live site: https://docs.wavs.xyz/

Build Locally

npm i
npm run dev

Link Checking

To check for broken links in the documentation:

npm run check-links

This command will:

  1. Kill any existing server on port 3000
  2. Start a new dev server
  3. Check all internal links
  4. Kill the server when done

The link checker is also integrated into the build process (npm run build), ensuring no broken links make it to production.

These docs were created using Fumadocs.

LLM and Machine-Readable Documentation

This documentation site offers machine-readable formats that make it easy for AI assistants and tools to access the content:

  • https://docs.wavs.xyz/llms.txt - Structured index of documentation organized by sections with titles, URLs, and descriptions

  • https://docs.wavs.xyz/llms-full.txt - All documentation in a single text file

  • Append .md to any page URL to get it in standard Markdown format:

    • https://docs.wavs.xyz/overview.md - Overview page as Markdown
    • https://docs.wavs.xyz/tutorial/1-overview.md - Tutorial intro as Markdown

Updating the theme

This site is built with Fumadocs. To update the theme, navigate to tailwind.config.js, and global.css. Styles are generated/applied by the tailwind config, which references the variables defined in the global CSS file.

Because the actual class names are generated by Fumadocs, you'll have to overwrite/"extend" the variables you want to change, and play around with what does what. They are loosely based on shad/cn's theming, which may be a good reference.

Docs components

Callouts

import { Callout } from 'fumadocs-ui/components/callout';
<Callout title="Info" type="info">
  Hello World
</Callout>

<Callout title="Error" type="error">
  Hello World
</Callout>

<Callout title="Warn" type="warn">
  Hello World
</Callout>

Cards

import {Layers, Microscope } from 'lucide-react';

<Cards>
  <Card
    icon={<Layers />}
    href="/about"
    title="About"
    description="Learn about WAVS"
  />
    <Card
    icon={<Microscope />}
    href="/how-it-works"
    title="How it works"
    description="Discover how WAVS works"
  />
</Cards>

Tabs

import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

<Tabs items={['Javascript', 'Rust']}>
  <Tab value="Javascript">Javascript is weird</Tab>
  <Tab value="Rust">Rust is fast</Tab>
</Tabs>