Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
bd9ba88
docs: fix invalid backtick
Ehesp Apr 23, 2026
e7d13bb
docs: remove old components
Ehesp May 27, 2026
8e7cfb2
docs: update config
Ehesp Jun 2, 2026
e4abed7
docs: update config
Ehesp Jun 2, 2026
aa583bc
refactor: overhaul docs.page to be agent ready (#488)
Ehesp Jun 29, 2026
4f46cf7
Update link to CONTRIBUTING.md in README
alexdukeinvertase Jun 29, 2026
3bb8960
fix: update homepage embed preview
Ehesp Jun 29, 2026
32ae517
feat: improve 404 page with debug mode
Ehesp Jun 29, 2026
8086d5a
fix(agent): implement openai, anthropic, and xai backend providers (#…
claude[bot] Jun 30, 2026
4859a4c
fix: only comment on PRs that change docs files (#287) (#491)
claude[bot] Jun 30, 2026
eced7ab
fix: Add horizontal padding to the "Trusted by" homepage section (#489)
claude[bot] Jun 30, 2026
de6ccff
fix: include $schema in json config
Ehesp Jun 30, 2026
1555be7
fix: hide page title if configured fixes #428
Ehesp Jun 30, 2026
b7928c1
feat: support github alert blocks. fixes #405
Ehesp Jun 30, 2026
b7cb6b3
feat: support multiple sidebar tabs. fixes #411
Ehesp Jun 30, 2026
ef34679
ci: add test pr workflow
Ehesp Jun 30, 2026
24f0318
fix: allow code group title horizonal overflow
Ehesp Jun 30, 2026
41f37b7
feat: add data-docs-page marker
Ehesp Jun 30, 2026
bf53485
chore: add contributor governance , agent md, skills folder, and issu…
alexdukeinvertase Jun 30, 2026
4df56f3
feat: server-side PostHog analytics (#492)
claude[bot] Jul 2, 2026
ca8319a
fix: correctly handle `get started` homepage link
Ehesp Jul 2, 2026
5cf5d71
Merge branch 'main' of https://github.com/invertase/docs.page
Ehesp Jul 2, 2026
677cb07
fix: remove Discord from footer social links (#502)
claude[bot] Jul 2, 2026
8c9fad4
feat(config): support config-driven redirects for doc pages (#503)
claude[bot] Jul 2, 2026
afbdcec
docs: bring over documentation content from #478 (#504)
claude[bot] Jul 2, 2026
9a314c9
docs: add Privacy Policy page at /legal/privacy
claude Jun 30, 2026
b9285ad
remove summary
BenInvertase Jun 30, 2026
b7775bb
docs: stub Terms of Service page at /legal/terms
claude Jun 30, 2026
924c038
docs: add draft Terms of Service page at /legal/terms
claude Jun 30, 2026
714c790
docs(legal): fill terms.mdx placeholders (governing law, liability, c…
claude Jun 30, 2026
69def52
docs(legal): set terms.mdx effective date to 30 June 2026
claude Jun 30, 2026
c6842f2
docs(legal): apply legal review edits to privacy and terms
claude Jun 30, 2026
0d4391d
docs(legal): collapse duplicate notice sentences in Terms section 12
claude Jun 30, 2026
50255a7
docs(privacy): soften "irreversibly hashed" to "hashed"
claude Jul 2, 2026
6d942b9
Apply suggestion from @Ehesp
Ehesp Jul 2, 2026
dd12f53
Update docs/legal/terms.mdx
Ehesp Jul 2, 2026
20595df
Update docs/legal/privacy.mdx
Ehesp Jul 2, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 10 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
**/node_modules
**/.next
**/.turbo
**/.cache
**/dist
**/build
**/.DS_Store
**/*.log
**/.env*
.git
106 changes: 106 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
name: Bug report
description: Something is broken on docs.page, in the CLI, or in local preview
title: "[Bug]: "
labels:
- bug
body:
- type: markdown
attributes:
value: |
Thanks for reporting a bug. Search [existing issues](https://github.com/invertase/docs.page/issues?q=is%3Aissue+is%3Aopen) first.

**Not sure where to start?** Use [Discussions](https://github.com/invertase/docs.page/discussions) for questions and ideas.

If this is about **your own published docs site**, include the docs.page URL and the GitHub repo below.

- type: dropdown
id: surface
attributes:
label: Where does this happen?
options:
- Hosted docs site (a URL on docs.page)
- CLI local preview (`docs.page preview`)
- Both hosted and preview
- Not sure
validations:
required: true

- type: input
id: docs_url
attributes:
label: docs.page URL
description: The page where you see the problem, if applicable.
placeholder: https://invertase.docs.page/configuration

- type: input
id: repo
attributes:
label: GitHub repository
description: The repo whose docs you are viewing, if applicable.
placeholder: invertase/docs.page

- type: textarea
id: description
attributes:
label: What happened?
description: What you did, what you expected, and what actually happened.
placeholder: |
When I …
I expected …
Instead …
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: Minimal steps, commands, or URLs. For CLI issues, include the exact command.
placeholder: |
1. Run `docs.page preview`
2. Open http://localhost:…/page
3. See …
validations:
required: true

- type: dropdown
id: area
attributes:
label: Area
options:
- Rendering / navigation / sidebar
- Search
- Preview mode (hosted PR/branch previews)
- CLI (`@docs.page/cli`)
- `docs.json` / configuration
- MCP / agent features
- Product docs (use.docs.page content)
- Other
validations:
required: true

- type: input
id: version
attributes:
label: CLI version or browser
description: e.g. `@docs.page/cli 2.0.0-next.1`, Chrome 124, Safari 17
placeholder: "@docs.page/cli …"

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Console errors, CLI output, or stack traces.
render: shell

- type: upload
id: screenshots
attributes:
label: Screenshots or recordings
description: If applicable, upload images to help explain the problem.

- type: textarea
id: context
attributes:
label: Additional context
description: Preview URL, commit SHA, or anything else that helps reproduce the issue.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Feature request
description: Suggest an improvement to docs.page, the CLI, or the docs experience
title: "[Feature]: "
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
Describe the problem you want solved. For open-ended questions or roadmap chat, use [Discussions](https://github.com/invertase/docs.page/discussions) instead.

- type: textarea
id: problem
attributes:
label: Problem or use case
description: What problem does this solve? Who benefits (site owners, readers, maintainers)?
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed solution
description: How would you like this to work? Mockups, examples, or links to other docs sites are welcome.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Other approaches, workarounds, or tools you considered.

- type: dropdown
id: area
attributes:
label: Area
options:
- Hosted platform (docs.page)
- CLI (`@docs.page/cli`)
- `docs.json` / configuration
- Search / analytics
- Preview mode
- MCP / agent / AI features
- Product documentation / DX
- Other
validations:
required: true

- type: dropdown
id: impact
attributes:
label: How important is this to you?
options:
- Nice to have
- Would improve my workflow
- Blocking — I can't use docs.page the way I need
validations:
required: true

- type: checkboxes
id: contribution
attributes:
label: Contribution
options:
- label: I am willing to open a PR for this (with maintainer guidance)
- label: I can help test a prototype
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Questions, ideas & roadmap
url: https://github.com/invertase/docs.page/discussions
about: General questions, feedback, and roadmap — start here when you're not sure
- name: Configuration help
url: https://use.docs.page/configuration
about: docs.json options, navigation, themes — start here for setup questions
- name: Discord
url: https://invertase.link/discord
about: Chat with the community
33 changes: 33 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Fixes #

## Summary

<!-- What changed and why? -->

## Scope

- [ ] `app/` (hosted site, MCP, Ask AI)
- [ ] `packages/cli/`
- [ ] `packages/mdx-bundler/`
- [ ] `docs/` (product documentation)
- [ ] Repo / CI / other

## Type of change

- [ ] Bug fix
- [ ] New feature
- [ ] Documentation
- [ ] Refactor / chore

## Test plan

<!-- Commands run, URLs tested, screenshots. For UI changes, include before/after if helpful. -->

- [ ] `bun run check` passes locally
- [ ] Tested locally (`bun dev`, CLI command, or other relevant command)
- [ ] Updated `docs/` (if user-facing)
- [ ] Verified on a docs.page URL or local preview (if rendering/routing changed)

## Notes for reviewers

<!-- Breaking changes, migration steps, follow-ups, or areas that need extra attention. -->
53 changes: 53 additions & 0 deletions .github/workflows/publish-cli.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Publish CLI

on:
push:
tags:
- cli-v*
workflow_dispatch:

permissions:
id-token: write
contents: read

jobs:
publish:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Bun
uses: oven-sh/setup-bun@v2

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: "22"
registry-url: https://registry.npmjs.org

- name: Install npm for trusted publishing
run: npm install -g npm@11

- name: Install dependencies
run: bun install

- name: Typecheck
run: bun run typecheck
working-directory: packages/cli

- name: Verify tag matches package version
if: startsWith(github.ref, 'refs/tags/')
working-directory: packages/cli
run: |
TAG="${GITHUB_REF#refs/tags/cli-v}"
VERSION=$(node -p "require('./package.json').version")
if [ "$TAG" != "$VERSION" ]; then
echo "Tag cli-v${TAG} does not match package.json version ${VERSION}"
exit 1
fi

- name: Publish to npm
working-directory: packages/cli
run: npm publish --access public
14 changes: 13 additions & 1 deletion .github/workflows/pull_request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,16 @@ jobs:
with:
version: latest
- name: Run Biome
run: biome ci .
run: biome ci .

test:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Bun
uses: oven-sh/setup-bun@v2
- name: Install dependencies
run: bun install
- name: Run tests
run: bun test
65 changes: 65 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# docs.page — agent guidance

This file orients coding agents working in the docs.page monorepo. For human
contributors, see [CONTRIBUTING.md](./CONTRIBUTING.md).

## Project overview

docs.page serves markdown documentation from public GitHub repositories as modern,
agent-ready sites (MCP, `llms.txt`, optional Ask AI). The active codebase is a
Bun workspace centered on a Next.js app and shared packages.

## Monorepo layout

```
app/ Next.js app — rendering, API routes, MCP, agent panel
packages/cli/ @docs.page/cli — init, check, preview
packages/mdx-bundler/ Shared markdown → doc IR pipeline
docs/ Product documentation (MDX)
docs.json Site navigation for this repo's docs
skills/ Agent skills (SKILL.md per skill)
```


## Commands

| Task | Command |
| --- | --- |
| Install | `bun install` (repo root) |
| Dev server | `bun dev` or `cd app && bun dev` |
| Format + lint | `bun run check` (Biome, repo root) |
| CLI dev | `cd packages/cli && bun run dev` |
| CLI typecheck | `cd packages/cli && bun run typecheck` |

## Conventions

- **Runtime** — Bun for installs and scripts; Next.js App Router in `app/`.
- **Lint/format** — Biome (`biome.json`). Run `bun run check` before finishing.
- **UI** — shadcn/ui components live in `app/src/components/ui/`. Use existing primitives before adding dependencies.
- **Next.js** — Read `app/AGENTS.md` and `node_modules/next/dist/docs/` for Next.js 16 APIs (breaking vs training data).
- **Shared markdown pipeline** — Changes to doc rendering belong in `packages/mdx-bundler/` when they affect both app and CLI preview.
- **Scope** — Minimal diffs; match existing patterns; update `docs/` for user-visible behavior.

## Environment

Local app development against live GitHub content requires `GITHUB_PAT` in
`app/.env.local`. GitHub App credentials are only needed for webhook work.
See [CONTRIBUTING.md](./CONTRIBUTING.md) for setup.

Do not commit secrets, `.env`, or generated artifacts (`.next/`, `dist/`).

## Pull requests

- Link issues when applicable (`Fixes #123`).
- Follow [CONTRIBUTING.md](./CONTRIBUTING.md) for workflow and [.github/pull_request_template.md](./.github/pull_request_template.md) when opening a PR.
- Ensure Biome passes (`bun run check`).
- Prefer focused PRs with a clear description.

## Skills

Repo-wide skills live under [`skills/`](./skills/). Load a skill's `SKILL.md` when one exists for your task.

## Safety

- Do not disable security checks (webhook verification, sanitization, rate limits) without explicit maintainer approval.
- Treat user-supplied markdown and repository content as untrusted input.
Loading
Loading