Edit this site

Edit This Site¶

Use this page when you want to fix text, add a page, give someone access, or check why a change has not appeared online.

You do not need to use the command line for normal edits. GitHub’s web editor is enough.

First: Which Site Are You Editing?¶

Main links:

• Website: https://reflexionlab.io

• Docs: https://docs.reflexionlab.io

Older CNC domains should redirect to these links. Do not treat old domains as separate sites to edit.

What Is Public?¶

Only a small part of the docs is public:

• The docs home page.

• This edit guide.

• Any page covered by a share link, share code, or project password.

Most docs pages require signing in with a lab-approved Google account. Admin pages require an admin-approved Google account.

Quick Admin Answers¶

New lab member access:

1. Open the LabCatalog Google Sheet.

2. Add the person to the People tab with their Google email in Email.

3. Set Lab to Reflexion Lab or Cognitive & Neural Computation Lab.

4. Ask them to sign in at https://docs.reflexionlab.io.

Access-only email:

1. Open the same LabCatalog Google Sheet.

2. Add the Google email to the AuthWhitelist tab, column A.

3. Ask them to sign in at https://docs.reflexionlab.io.

Notes:

• The People tab is what we mean by the lab roster.

• The AuthWhitelist tab is for someone who needs docs access but should not appear as a roster/team member.

• The current access check does not filter by End_Date; remove or block old emails when people should lose access.

• For urgent code-level access, add the email to ALWAYS_ALLOWED_EMAILS in server/services/authWhitelistService.js, commit, and deploy.

Admin access:

1. Add the person to full docs access first.

2. Add their email to the admin allowlist.

3. Admin pages live under Admin/ and require both normal docs sign-in and admin approval.

GitHub editing access:

1. Add them to the CNClaboratory/cnclab_website GitHub repo or team.

2. They do not need a paid Vercel seat for normal docs edits.

3. Their changes publish after they land on master and Vercel Path Deploy succeeds.

If a GitHub edit does not go live, check Vercel Path Deploy for that commit. If GitHub says the job could not start because of payments, spending limits, or Actions minutes, the edit was saved but the site did not rebuild.

Edit an Existing Docs Page¶

1. Open the page on docs.reflexionlab.io.

2. Click the GitHub icon or pencil icon near the top of the page.

3. Edit the text in GitHub.

4. Choose Commit changes.

5. Wait for the Vercel Path Deploy workflow to finish.

6. Refresh the docs page.

GitHub saves your edit immediately. The public docs site changes only after the deploy finishes.

Add a New Docs Page¶

1. Create a Markdown file in the right folder under docs-book/.

2. Add the page to docs-book/myst.yml so it appears in the sidebar.

3. Commit both files.

4. Wait for the docs deploy.

Common folders:

Example myst.yml entry:

- title: "Getting Started"
  children:
    - title: "Welcome"
      file: Getting-Started/01-Welcome.md
    - title: "New Page Title"
      file: Getting-Started/06-New-Page.md

The sidebar order comes from myst.yml, not from the filename.

Check Whether Your Edit Is Live¶

1. Open the commit or pull request in GitHub.

2. Open the Actions tab for that commit.

3. Look for Vercel Path Deploy.

4. If it is green, refresh the public page.

5. If it failed or never started, send the workflow link to an admin.

If GitHub shows a message about failed payments, spending limits, or a job that never starts, your text was saved but the site did not rebuild. That is a GitHub Actions runner/billing problem, not a problem with your edit.

Admins should check the Website Admin Guide.

Do Not Edit Generated Files Directly¶

Some pages are copied or generated from another source. If you edit the generated copy, your change may be overwritten later.

Before editing a page, look for a note near the top that says it is mirrored from another file. If you see that note, edit the source file named in the note.

When in doubt, open an issue and ask where the source lives:

https://github.com/CNClaboratory/cnclab_website/issues/new

Writing Guidelines¶

• Use short headings.

• Put the action first.

• Avoid unexplained acronyms.

• Link to the source system when someone needs to leave the docs.

• Say what happens next after each step.

For more writing guidance, see Documentation Writing Guide.