https://github.com/superfaceai/docs
Superface.ai Official Documentation
https://github.com/superfaceai/docs
comlink documentation superface
Last synced: 6 months ago
JSON representation
Superface.ai Official Documentation
- Host: GitHub
- URL: https://github.com/superfaceai/docs
- Owner: superfaceai
- License: cc-by-4.0
- Created: 2021-07-29T08:55:41.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-14T12:57:14.000Z (7 months ago)
- Last Synced: 2024-11-14T13:36:31.655Z (7 months ago)
- Topics: comlink, documentation, superface
- Language: Jupyter Notebook
- Homepage: https://superface.ai/docs
- Size: 27.8 MB
- Stars: 12
- Watchers: 8
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: docs/support.mdx
Awesome Lists containing this project
README
# Superface Documentation
This repository contains the documentation website code and Markdown source files for https://superface.ai/docs.
## Contribute to docs
1. ### Run the docs locally
- Clone the repo, then `yarn install` and `yarn start`
2. ### Update the content
- Make your desired changes to the documents inside
[`/docs`](https://github.com/superfaceai/docs/tree/main/docs) directory
It uses a standard Markdown syntax, but can be extended with custom React components via MDX.
[Help for Markdown features ➚](https://docusaurus.io/docs/markdown-features)
- Put your static content (e.g. images) to
[`/static`](https://github.com/superfaceai/docs/tree/main/static) directory
When linking to it from the docs, just drop `/static` from path, e.g. rendering `/img/diagram.png`
will render an image saved at `/static/img/diagram.png`.
[Help for static assets ➚](https://docusaurus.io/docs/static-assets)
- Reference other docs via Markdown file path
Linking to another document is preferably done via specifying the relative path to that
document (`./next-step.md`). Exceptions are pages placed in `src/pages/` directory that need
to be linked using their respective routes.
[Help for referencing docs ➚](https://docusaurus.io/docs/docs-markdown-features#referencing-other-documents)
3. ### Update the content structure _(optional)_
- **Page rename, new page, category; or change of structure**
If you added a whole new category, page or simply want to change the table of contents,
you'll need to update [`sidebars.js`](https://github.com/superfaceai/docs/blob/main/sidebars.js).
It uses document IDs that are simply a path to the file minus the extension (unless explicitly
defined inside the document).
[Help for Sidebar ➚](https://docusaurus.io/docs/sidebar)
- **Changing links in header navigation**
Navigation links are defined in [`docusaurus.config.js`](https://github.com/superfaceai/docs/blob/main/docusaurus.config.js)
in `themeConfig.navbar.items` object.
[Help for config ➚](https://docusaurus.io/docs/docusaurus.config.js)
4. ### Get the changes reviewed
- When you're happy with your changes, open a PR and get it reviewed by someone.
_Opening a PR will automatically deploy an online preview of your docs. It also verifies the build
doesn't contain any broken links._
5. ### Deploy to production
- Once your changes are verified and reviewed by another pair of eyes, it is ready to be merged to `main`.
_Merging will automatically deploy `main` branch to production._
## Tech Stack
These docs are built using [Docusaurus 3](https://docusaurus.io/).
Details
The site is deployed on [Vercel](https://vercel.com/).
All deployments are automated via GitHub Actions and you can keep track of them
in [the repository's environments](https://github.com/superfaceai/docs/deployments).
- Preview: gets deployed for each PR
- Production: gets deployed continuously from `main` branch
Each deploy first verifies the validity of the build.
If you'd like to build locally:
```bash
yarn build
```
## License
The Superface documentation is licensed under a [Creative Commons Attribution 4.0 International license](./LICENSE).