Skip to content

polaris-data/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Polaris docs

This repository contains the source for the Polaris documentation site at docs.polaris.supply.

If you want to use Polaris, start with the live docs:

Local development

Install the Mintlify CLI:

npm i -g mint

Run the docs locally from the repository root:

mint dev

The local preview runs at http://localhost:3000.

Project structure

  • docs.json contains site-wide configuration and navigation.
  • *.mdx files contain documentation pages.
  • images/ contains static assets.

Publishing

Changes deployed from the default branch update the production docs site automatically.

Writing notes

  • Use active voice and second person.
  • Keep sentences concise.
  • Format UI labels in bold.
  • Format commands, paths, and filenames in code style.

About

Polaris docs hosted on Mintlify.

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

Generated from mintlify/starter