Editing Documentation

This site uses Docusaurus with multiple unversioned docs instances — not Docusaurus versioning. Each product has its own folder, route, and sidebar.

Doc instances

Folder	URL prefix	Sidebar config
community/	/community/	sidebarsCommunity.js
creativetv/	/creativetv/	sidebarsCreativetv.js
creativebank/	/creativebank/	/creativebank/

Configuration lives in docusaurus.config.js (multi-instance docs).

Create or edit a page

1. Add or edit a Markdown file in the correct folder (e.g. community/security/risks.md).
2. Include frontmatter at the top (create a doc):

---
id: my-page
title: My Page
sidebar_position: 1
---

# My Page

Content here.

• id — URL slug (/community/my-page unless nested in a subfolder)
• title — sidebar and page title
• sidebar_position — order within the category (lower = higher)

Sidebars are autogenerated from the folder tree and _category_.json files. No manual sidebar edit is required for most changes.

Remove a page

Delete the .md file. Rebuild the site. If external links may still hit the old URL, add a redirect under static/ (see static/community/security/bounties/index.html).

Local preview

yarn
yarn start

Open the relevant route (e.g. http://localhost:3000/community/intro).

Before opening a PR

yarn build

onBrokenLinks is set to throw — broken internal links fail the build.

After merge (go live)

1. Deploy the site — production is updated when creative-website is built and deployed (Surge / hosting pipeline). Merging to master alone does not update the live site until deploy runs.
2. Refresh search — Algolia is not updated automatically:

yarn algolia:sync

Requires ADMIN_API_KEY in .env. See scripts/README.md.

What we do not use

• Docusaurus versioning — community, Creative TV, and Creative Bank docs are all current / unversioned.
• Manual Algolia crawler — we export from Markdown via scripts/algolia-export.js.