Skip to content
Merged
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
90 changes: 25 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,12 @@
# agentling docs
# Agentling Docs

[![CI](https://github.com/lunarstack-co/agentling-docs/actions/workflows/ci.yml/badge.svg)](https://github.com/lunarstack-co/agentling-docs/actions/workflows/ci.yml)

**Live at [agentling.dev](https://agentling.dev)**
Source for **[agentling.dev](https://agentling.dev)**, the documentation site for [Agentling](https://github.com/lunarstack-co/agentling).

The documentation website for [agentling](https://github.com/lunarstack-co/agentling), a tiny async framework for reliable, observable, tool-using agents in Python. Deployed on Railway; every push to `main` deploys automatically.
Built with Next.js 16 (App Router), Tailwind CSS v4, and local Markdown. No external CMS or database required.

The site includes an animated homepage, full documentation with sidebar navigation, search, and a table of contents, a blog for releases and technical writing, a changelog, contributing instructions, and legal pages. Light and dark themes are supported, with dark as the default.

## Stack

- [Next.js 16](https://nextjs.org/) (App Router, TypeScript, Turbopack)
- [Tailwind CSS v4](https://tailwindcss.com/) with semantic design tokens
- [Motion](https://motion.dev/) for animation, [shiki](https://shiki.style/) via rehype-pretty-code for syntax highlighting
- Content as markdown in the repository, no CMS and no external services

## How content works

Everything the site renders lives in `/content` as markdown with frontmatter:

```
content/
docs/<section>/_section.md section title, icon, and sidebar order
docs/<section>/<page>.md one documentation page
blog/<slug>.md one blog post
changelog/<version>.md one release
pages/<slug>.md contributing, privacy, terms
```

`src/lib/content/index.ts` reads these files at build time and every page is statically generated. Publishing a doc page, blog post, or changelog entry is:

1. Add or edit a markdown file in `/content`.
2. Commit and push (or open a pull request).
3. The next deploy ships it.

There are no environment variables, tokens, or external services required, which also means contributions to the docs are ordinary pull requests.

## Getting started
## Quickstart

Requires Node.js 20.9 or newer.

Expand All @@ -47,49 +17,39 @@ npm install
npm run dev
```

The site runs at `http://localhost:3000`.

## Writing content
Runs locally at `http://localhost:3000`.

Frontmatter fields by content type:
## Content structure

| Type | Required | Optional |
| --- | --- | --- |
| Doc section (`_section.md`) | `title`, `slug`, `order` | `description`, `icon` (lucide name) |
| Doc page | `title`, `slug`, `order` | `description` |
| Blog post | `title`, `slug`, `publishDate` | `excerpt`, `authorName`, `tags`, `featured`, `readingMinutes` |
| Changelog entry | `version`, `releaseDate` | `title`, `tags` |
| Site page | `title`, `slug` | `description` |
All content lives in `/content` as plain Markdown with frontmatter:

The body of every file is standard GitHub-flavored markdown. Code fences are syntax highlighted, h2/h3 headings automatically appear in the on-page table of contents and get hover anchor links, and GitHub alert syntax renders as styled callouts:

```markdown
> [!NOTE]
> Renders as a callout. Also supported: [!TIP], [!IMPORTANT], [!WARNING], [!CAUTION].
```
content/
docs/<section>/_section.md # Section title and order
docs/<section>/<page>.md # Documentation page
changelog/<version>.md # Release entry
pages/<slug>.md # Contributing, privacy, terms
```

## Machine-readable surfaces

- `/feed.xml` and `/changelog.xml`: RSS feeds for the blog and releases.
- `/llms.txt` and `/llms-full.txt`: an LLM-friendly site index and the full documentation corpus as plain markdown ([llmstxt.org](https://llmstxt.org)).
- `/search-index.json`: the full-content index behind the site search.
- Every doc page has a "Copy as Markdown" button for pasting into an LLM.
Every page is statically generated at build time. To update documentation, edit the markdown file and open a PR.

## Checks
## Validation and checks

All of these run in CI on every pull request:
Run all checks locally before submitting a PR:

```bash
npm run validate # content: frontmatter, slugs, internal links, no em dashes
npm run lint # eslint
npx tsc --noEmit # types
npm run build # production build
npm run validate # checks frontmatter, slugs, and internal links
npm run lint # eslint
npx tsc --noEmit # type check
npm run build # static export build
```

## Contributing
## Machine-readable endpoints

Contributions are welcome. See the [contributing guide](https://agentling.dev/contributing) for the project conventions, and open a pull request against this repository for anything site related.
- `/changelog.xml`: RSS feed for releases.
- `/llms.txt` & `/llms-full.txt`: plain-text documentation indexes for LLM context.
- `/search-index.json`: local fuzzy search index.

## License

MIT, consistent with the agentling framework itself.
[MIT](https://github.com/lunarstack-co/agentling/blob/main/LICENSE)
86 changes: 0 additions & 86 deletions content/blog/introducing-agentling.md

This file was deleted.

62 changes: 0 additions & 62 deletions content/blog/one-loop-two-modes.md

This file was deleted.

72 changes: 0 additions & 72 deletions content/blog/skills-that-stay-out-of-the-way.md

This file was deleted.

Loading
Loading