Skip to content

About

The docs site for the celerity framework powered by fumadocs

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Celerity Docs

The website that provides documentation along with a blog for the Celerity project. This contains general documentation for the high-level concepts and components of Celerity along with versioned documentation for the runtimes, packages and applications that make up Celerity.

This is a Next.js application generated with Create Fumadocs.

Run development server:

npm run dev
# or
pnpm dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

Explore

In the project, you can see:

  • lib/source.ts: Code for content source adapter, loader() provides the interface to access your content.
  • lib/layout.shared.tsx: Shared options for layouts, optional but preferred to keep.
Route Description
app/(home) The route group for your landing page and other pages.
app/docs The documentation layout and pages.
app/api/search/route.ts The Route Handler for search.

Fumadocs MDX

A source.config.ts config file has been included, you can customise different options like frontmatter schema.

Read the Introduction for further details.

Partial Versioning

The Celerity docs site is made up of sections for different components of the framework.

The following components are independently versioned:

  • CLI
  • Workflow Runtime
  • Node.js Runtime/SDK
  • Python Runtime/SDK
  • C#/.NET Runtime/SDK
  • Go SDK

Versioning is implemented using folders as per the fumadocs versioning documentation.

Each version folder should have a meta.json file that lists the pages for the version, with the first page being the getting started/introduction page.

The component root folder should have a meta.json file that lists the version folders in the pages directory, the ordering should be most recent version first.

For example, for a component that has 2 versions, the meta.json file would look like this:

{
  // Other metadata ...
  "pages": ["v2", "v1"]
}

Validating links

To validate links in the documentation, you can run the following command:

yarn check-links

This will look for broken or invalid links, however, it will not detect missing pages under a [[...slug]] route such as docs/framework/auth/missing-page that comes under the docs/[[...slug]] route.

Learn More

To learn more about Next.js and Fumadocs, take a look at the following resources:

About

The docs site for the celerity framework powered by fumadocs

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages