Skip to content

synthetic-sciences/docs

Repository files navigation

      ███████╗██╗   ██╗███╗   ██╗████████╗██╗  ██╗███████╗████████╗██╗ ██████╗
      ██╔════╝╚██╗ ██╔╝████╗  ██║╚══██╔══╝██║  ██║██╔════╝╚══██╔══╝██║██╔════╝
      ███████╗ ╚████╔╝ ██╔██╗ ██║   ██║   ███████║█████╗     ██║   ██║██║     
      ╚════██║  ╚██╔╝  ██║╚██╗██║   ██║   ██╔══██║██╔══╝     ██║   ██║██║     
      ███████║   ██║   ██║ ╚████║   ██║   ██║  ██║███████╗   ██║   ██║╚██████╗
      ╚══════╝   ╚═╝   ╚═╝  ╚═══╝   ╚═╝   ╚═╝  ╚═╝╚══════╝   ╚═╝   ╚═╝ ╚═════╝
           ███████╗ ██████╗██╗███████╗███╗   ██╗ ██████╗███████╗███████╗
           ██╔════╝██╔════╝██║██╔════╝████╗  ██║██╔════╝██╔════╝██╔════╝
           ███████╗██║     ██║█████╗  ██╔██╗ ██║██║     █████╗  ███████╗
           ╚════██║██║     ██║██╔══╝  ██║╚██╗██║██║     ██╔══╝  ╚════██║
           ███████║╚██████╗██║███████╗██║ ╚████║╚██████╗███████╗███████║
           ╚══════╝ ╚═════╝╚═╝╚══════╝╚═╝  ╚═══╝ ╚═════╝╚══════╝╚══════╝
                                                                    docs

The source for docs.syntheticsciences.ai.

site license OpenScience

About

This repository is the whole docs site: a small Vite + React app that renders a folder of MDX pages. There is no docs framework, no CMS, and no server. Merges to main deploy automatically.

It documents three products:

Development

npm install
npm run dev        # hot-reloads .mdx edits

Before opening a PR:

npm run validate   # link check plus a production build

Adding a page

  1. Create src/content/<section>/<page>.mdx with title and description frontmatter.
  2. Add the page to that section's docs.json under the right group.
  3. Run npm run check-links to confirm the nav and every internal link resolve.

Each section lives in src/content/<section>/ as .mdx pages plus a docs.json for the sidebar. Routing is hash-based (#/<section>/<page>), and URLs from older layouts redirect through the alias maps in src/DocsApp.tsx, so old links keep working.

Style guide

  • Copy says "Atlas", "OpenScience", or "Synthetic Sciences". No internal vendor names.
  • OpenScience docs present bring-your-own-key as the default; Atlas is optional, never required.
  • Use canonical singular command names. Installs always use @latest.
  • Active voice, second person, sentence case headings.

License

MIT for this site; see LICENSE. The products keep their own licenses (OpenScience is Apache-2.0).

About

Source for docs.syntheticsciences.ai: Atlas, OpenScience, and Library documentation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors