DottaandDevRel Gemini 1f6b9f3846 docs: redirect legacy what-is-paperclip URL (#93)
## Thinking Path

> - Paperclip uses a public documentation site to help users learn the
product.
> - The site build reads legacy routes from `site/redirects.json`.
> - Two old `/start/` routes redirect to current guide pages.
> - The old `/start/what-is-paperclip` route has no matching redirect.
> - Search engines still send users to that old route.
> - This pull request adds the missing redirect entry.
> - The benefit is a working 301 response for both slash variants.

## Linked Issues or Issue Description

**Issue type**

Outdated documentation route.

**Where is the issue?**

`https://docs.paperclip.ing/start/what-is-paperclip`

**What's wrong?**

The legacy URL returns a hard 404. The live replacement is
`/guides/welcome/what-is-paperclip/`.

**Suggested fix**

Add the proven legacy path to `site/redirects.json`. Do not add
speculative `/start/` redirects.

## What Changed

- Added `start/what-is-paperclip` to the legacy redirect map.
- Kept the existing `start/quickstart` and `start/core-concepts`
mappings unchanged.

## Verification

- Ran `npm run docs:test:static-routes` successfully.
- Ran `npm run docs:build` successfully.
- Confirmed the generated `_redirects` file contains 301 rules for both
`/start/what-is-paperclip` variants.
- Confirmed the generated sibling rules remain present.

## Risks

- Low risk. The change adds one redirect map entry and does not change
page content or route generation logic.

## Model Used

- OpenAI `gpt-5.4` through Codex CLI, with reasoning, tool use, and code
execution. The runtime does not expose the context window size.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change and contains no internal
ticket ID
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All configured CI gates are green
- [x] No Greptile check is configured for this repository, and no
Greptile comments are open
- [x] I will address all Greptile and reviewer comments before
requesting merge

Co-authored-by: DevRel Gemini <[email protected]>
2026-08-13 10:09:01 -04:00
2026-04-30 11:04:18 -05:00

Paperclip Docs

Source for the 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:

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.

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 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

License

Copyright (c) 2026 Paperclip Community.

The Paperclip software is open source — see the main 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). 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 for the full text.

S
Description
Paperclip documentation
Readme CC-BY-4.0
491 MiB
0 Stars 1 Watchers 0 Forks
Languages
JavaScript 91.1%
CSS 7.1%
HTML 1.6%
Shell 0.2%