https://github.com/cstrnt/docs
Fig's public docs
https://github.com/cstrnt/docs
Last synced: 5 months ago
JSON representation
Fig's public docs
- Host: GitHub
- URL: https://github.com/cstrnt/docs
- Owner: cstrnt
- Created: 2021-03-13T09:13:48.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-03-16T20:12:53.000Z (about 5 years ago)
- Last Synced: 2025-10-10T11:03:34.969Z (8 months ago)
- Size: 25.2 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Support: support/cli-tool-not-installed.md
Awesome Lists containing this project
README
# Fig Docs
This repo hosts all of Fig's docs, found at [withfig.com/docs](https://withfig.com/docs).
To make changes to a doc, fork this repo and submit a PR.
## Adding a new doc
Under the docs folder, you'll find a bunch of markdown files, with even more markdown files inside some nested folders. These files represent each doc's contents and their URL path. For example, if you wanted to add something under the Autocomplete section of the sidebar, make sure to add that markdown file under the /autocomplete folder. Files under the /autocomplete folder will also be routed under withfig.com/docs/autocomplete.
After moving the .md file into the right /docs path, we need to set up URL routing to your doc. Routing is handled by the `manifest.json` file found under /docs. This file also determines the order that the docs will show up on the sidebar.
**Additional properties**
- To create a hidden page, one that can be accessed via URL but can't be found in the sidebar (ex: [https://withfig.com/docs/support/secure-keyboard-input](https://withfig.com/docs/support/secure-keyboard-input)), add `"show": false`.
```js
{
"title": "Secure Keyboard Input",
"path": "support/secure-keyboard-input.md",
"show": false
}
```
## Updating a doc
You can make changes to any of the docs by directly editing the .md files in the /docs folder. To change the order that docs show up on the sidebar, rearrange the manifest.json accordingly.
Questions? Email [hello@withfig.com](mailto:hello@withfig.com)!