Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,9 @@ pnpm-debug.log*

# macOS-specific files
.DS_Store

# wrangler files
.wrangler
.dev.vars*
!.dev.vars.example
!.env.example
185 changes: 95 additions & 90 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -2,96 +2,101 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

import cloudflare from '@astrojs/cloudflare';

// https://astro.build/config
export default defineConfig({
site: 'https://docs.writ.build',
integrations: [
starlight({
title: 'writ',
description:
'Writ is a language and a runtime for bounded agent authority. You write the terms. The registrar enforces them.',
favicon: '/writ-favicon-64.png',
customCss: ['./src/styles/writ.css'],
components: {
// The wordmark is the mark: wr, a blinking caret, then t.
SiteTitle: './src/components/SiteTitle.astro',
},
head: [
{ tag: 'link', attrs: { rel: 'preconnect', href: 'https://fonts.googleapis.com' } },
{
tag: 'link',
attrs: { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: true },
},
{
tag: 'link',
attrs: {
rel: 'stylesheet',
href: 'https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;500;600&family=Instrument+Sans:wght@400;500;600;700&display=swap',
},
},
{ tag: 'link', attrs: { rel: 'apple-touch-icon', href: '/writ-appicon-180.png' } },
{ tag: 'meta', attrs: { name: 'theme-color', content: '#10141c' } },
{
tag: 'meta',
attrs: { property: 'og:image', content: 'https://docs.writ.build/writ-og.png' },
},
{ tag: 'meta', attrs: { name: 'twitter:card', content: 'summary_large_image' } },
],
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/sirrobot01/writ' }],
editLink: { baseUrl: 'https://github.com/sirrobot01/writ/edit/main/docs/' },
lastUpdated: true,
sidebar: [
{
label: 'Start',
items: [
{ label: 'What Writ does', slug: 'start/what-writ-does' },
{ label: 'Install Writ', slug: 'start/install' },
{ label: 'Write your first writ', slug: 'start/first-writ' },
{ label: 'Configure the engagement', slug: 'start/configure' },
],
},
{
label: 'The writ file',
items: [
{ label: 'Structure', slug: 'writ-file/structure' },
{ label: 'Mandate', slug: 'writ-file/mandate' },
{ label: 'Grants', slug: 'writ-file/grants' },
{ label: 'Bounds', slug: 'writ-file/bounds' },
{ label: 'Invariants', slug: 'writ-file/invariants' },
{ label: 'Satisfaction', slug: 'writ-file/satisfaction' },
{ label: 'Obligations', slug: 'writ-file/obligations' },
{ label: 'Remedies', slug: 'writ-file/remedies' },
{ label: 'Placeholders', slug: 'writ-file/placeholders' },
],
},
{
label: 'Concepts',
items: [
{ label: 'The three check layers', slug: 'concepts/layers' },
{ label: 'The registrar', slug: 'concepts/registrar' },
{ label: 'The record', slug: 'concepts/record' },
],
},
{
label: 'Commands',
items: [
{ label: 'writ init', slug: 'cli/init' },
{ label: 'writ check', slug: 'cli/check' },
{ label: 'writ issue', slug: 'cli/issue' },
{ label: 'writ record', slug: 'cli/record' },
{ label: 'writ amend', slug: 'cli/amend' },
{ label: 'writ proxy', slug: 'cli/proxy' },
{ label: 'writ configure', slug: 'cli/configure' },
],
},
{
label: 'Reference',
items: [
{ label: 'Terms', slug: 'reference/terms' },
{ label: 'Exit codes', slug: 'reference/exit-codes' },
],
},
],
}),
site: 'https://docs.writ.build',

integrations: [
starlight({
title: 'writ',
description:
'Writ is a language and a runtime for bounded agent authority. You write the terms. The registrar enforces them.',
favicon: '/writ-favicon-64.png',
customCss: ['./src/styles/writ.css'],
components: {
// The wordmark is the mark: wr, a blinking caret, then t.
SiteTitle: './src/components/SiteTitle.astro',
},
head: [
{ tag: 'link', attrs: { rel: 'preconnect', href: 'https://fonts.googleapis.com' } },
{
tag: 'link',
attrs: { rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: true },
},
{
tag: 'link',
attrs: {
rel: 'stylesheet',
href: 'https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;500;600&family=Instrument+Sans:wght@400;500;600;700&display=swap',
},
},
{ tag: 'link', attrs: { rel: 'apple-touch-icon', href: '/writ-appicon-180.png' } },
{ tag: 'meta', attrs: { name: 'theme-color', content: '#10141c' } },
{
tag: 'meta',
attrs: { property: 'og:image', content: 'https://docs.writ.build/writ-og.png' },
},
{ tag: 'meta', attrs: { name: 'twitter:card', content: 'summary_large_image' } },
],
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/sirrobot01/writ' }],
editLink: { baseUrl: 'https://github.com/sirrobot01/writ/edit/main/docs/' },
lastUpdated: true,
sidebar: [
{
label: 'Start',
items: [
{ label: 'What Writ does', slug: 'start/what-writ-does' },
{ label: 'Install Writ', slug: 'start/install' },
{ label: 'Write your first writ', slug: 'start/first-writ' },
{ label: 'Configure the engagement', slug: 'start/configure' },
],
},
{
label: 'The writ file',
items: [
{ label: 'Structure', slug: 'writ-file/structure' },
{ label: 'Mandate', slug: 'writ-file/mandate' },
{ label: 'Grants', slug: 'writ-file/grants' },
{ label: 'Bounds', slug: 'writ-file/bounds' },
{ label: 'Invariants', slug: 'writ-file/invariants' },
{ label: 'Satisfaction', slug: 'writ-file/satisfaction' },
{ label: 'Obligations', slug: 'writ-file/obligations' },
{ label: 'Remedies', slug: 'writ-file/remedies' },
{ label: 'Placeholders', slug: 'writ-file/placeholders' },
],
},
{
label: 'Concepts',
items: [
{ label: 'The three check layers', slug: 'concepts/layers' },
{ label: 'The registrar', slug: 'concepts/registrar' },
{ label: 'The record', slug: 'concepts/record' },
],
},
{
label: 'Commands',
items: [
{ label: 'writ init', slug: 'cli/init' },
{ label: 'writ check', slug: 'cli/check' },
{ label: 'writ issue', slug: 'cli/issue' },
{ label: 'writ record', slug: 'cli/record' },
{ label: 'writ amend', slug: 'cli/amend' },
{ label: 'writ proxy', slug: 'cli/proxy' },
{ label: 'writ configure', slug: 'cli/configure' },
],
},
{
label: 'Reference',
items: [
{ label: 'Terms', slug: 'reference/terms' },
{ label: 'Exit codes', slug: 'reference/exit-codes' },
],
},
],
}),
],
});

adapter: cloudflare(),
});
Loading
Loading