mirror of
https://github.com/paperclipai/paperclip-docs.git
synced 2026-11-07 06:16:07 -10:00
Michael Nguyen
9f46125a8d
## Summary
Adds the hosted beta getting-started guide and FAQ at `/hosted-beta/`,
using the existing docs header, sidebar, article layout, theme controls,
and table of contents.
The page remains outside the navigation/search manifest, homepage
listings, previous/next links, and sitemap, with a `noindex` directive.
Direct-link visitors can navigate into the regular docs. This is a
public, unlisted page rather than access-controlled content.
## Validation
- Root and subpath builds and unlisted discovery checks pass.
- Existing static route verification passes.
- Desktop and mobile browser checks show no overflow or runtime errors.
- Table-of-contents anchors and navigation into regular docs verified.
Local preview: http://127.0.0.1:4337/hosted-beta/
Hosted preview:
https://aa3d8178.paperclip-docs-74t.pages.dev/hosted-beta/
Cloudflare deployment succeeded for commit 4b94d17.
70 lines
3.6 KiB
Markdown
70 lines
3.6 KiB
Markdown
# Paperclip Docs
|
|
|
|
Source for the [Paperclip](https://github.com/paperclipai/paperclip) documentation site — user guides, API and CLI reference, adapter docs, and deployment notes.
|
|
|
|
**Read the docs:** https://docs.paperclip.ing/
|
|
|
|
## What's inside
|
|
|
|
- **Guides** — Getting started, core concepts, and day-to-day usage.
|
|
- **API reference** — Control-plane endpoints and payload schemas.
|
|
- **CLI reference** — `paperclip` command surface.
|
|
- **Adapters** — Plugin authoring and the integrations catalogue.
|
|
- **Deploy** — Self-hosting, upgrades, and operational guidance.
|
|
|
|
The site is a single static shell that renders the Markdown files in `docs/` directly — no framework, no build step required to read the raw pages.
|
|
|
|
## Build and deployment
|
|
|
|
Build a release bundle locally with:
|
|
|
|
```sh
|
|
npm run docs:build
|
|
```
|
|
|
|
Cloudflare Pages is connected directly to `paperclipai/paperclip-docs` through GitHub. There is no normal Wrangler publish step for this repo:
|
|
|
|
- Pushes to `main` deploy production at `https://docs.paperclip.ing/`.
|
|
- Pushes to other branches create Cloudflare Pages preview/canary deployments.
|
|
- Canary URLs are created by Cloudflare for each deployment, for example `https://92b9a99c.paperclip-docs-74t.pages.dev`. Use the URL shown in the Cloudflare Pages deployment row or GitHub deployment/check for the pushed branch and commit.
|
|
|
|
That auto-deploy is not guaranteed — it has silently failed to fire on a push to `main` before. After anything reader-facing lands, check the live site rather than the merge, and republish by hand if it's stale:
|
|
|
|
```sh
|
|
npm run docs:build
|
|
npx wrangler pages deploy .site --project-name paperclip-docs --branch main
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Spotted a typo, a broken link, or something that could be clearer? There are two easy paths, both linked from the footer of every docs page:
|
|
|
|
- **Suggest an edit** — opens the underlying Markdown file in GitHub's web editor. Make the change and submit a PR without leaving the browser.
|
|
- **Report an issue** — opens a prefilled [Docs feedback](.github/ISSUE_TEMPLATE/03-docs-feedback.yml) issue with the page URL already attached.
|
|
|
|
For larger changes, fork the repo and open a PR against `main`. Screenshots live under `docs/user-guides/screenshots/{light,dark}/` and should be provided in both themes when replacing UI captures.
|
|
|
|
## Community
|
|
|
|
- [Discord](https://discord.gg/m4HZY7xNG3)
|
|
- [GitHub Discussions](https://github.com/paperclipai/paperclip/discussions)
|
|
|
|
## License
|
|
|
|
Copyright (c) 2026 Paperclip Community.
|
|
|
|
The Paperclip **software** is open source — see the main [paperclip](https://github.com/paperclipai/paperclip) repository for its license.
|
|
|
|
The **documentation in this repository** is licensed under [Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0)](https://creativecommons.org/licenses/by-nc-nd/4.0/). You may read and share it for non-commercial purposes with attribution. Commercial use of any kind requires prior written permission from the copyright holders. See [`LICENSE`](LICENSE) for the full text.
|
|
|
|
### Unlisted hosted beta guide
|
|
|
|
`docs/hosted-beta.md` is built at `/hosted-beta/` by `site/build-release.mjs`.
|
|
It reuses the full docs shell and initializes page tools without adding the page to the navigation/search manifest.
|
|
Keep it out of `site/content.json`: it is deliberately absent from navigation,
|
|
search, homepage listings, previous/next links, and the sitemap. It has a
|
|
`noindex` meta tag; this is a public page, not an access-controlled document.
|
|
|
|
Run `node scripts/verify-unlisted-beta.mjs` to verify root/subpath builds and
|
|
exclusion from discovery. Preview with `npm run docs:build` and `npm run docs:serve`.
|