{"id":22080030,"url":"https://github.com/superfaceai/docs","last_synced_at":"2025-07-24T14:31:50.378Z","repository":{"id":37800515,"uuid":"390662102","full_name":"superfaceai/docs","owner":"superfaceai","description":"Superface.ai Official Documentation","archived":false,"fork":false,"pushed_at":"2024-11-14T12:57:14.000Z","size":29200,"stargazers_count":12,"open_issues_count":4,"forks_count":5,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-11-14T13:36:31.655Z","etag":null,"topics":["comlink","documentation","superface"],"latest_commit_sha":null,"homepage":"https://superface.ai/docs","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/superfaceai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/support.mdx","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-29T08:55:41.000Z","updated_at":"2024-11-14T12:57:16.000Z","dependencies_parsed_at":"2023-02-18T12:16:04.437Z","dependency_job_id":"3e3dc468-7bb9-450f-aa1d-9e800571d727","html_url":"https://github.com/superfaceai/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superfaceai%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superfaceai%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superfaceai%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superfaceai%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/superfaceai","download_url":"https://codeload.github.com/superfaceai/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227448649,"owners_count":17777325,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["comlink","documentation","superface"],"created_at":"2024-11-30T23:12:00.101Z","updated_at":"2024-11-30T23:12:00.536Z","avatar_url":"https://github.com/superfaceai.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Superface Documentation\n\nThis repository contains the documentation website code and Markdown source files for https://superface.ai/docs.\n\n## Contribute to docs\n\n1. ### Run the docs locally\n\n- Clone the repo, then `yarn install` and `yarn start`\n\n2. ### Update the content\n\n- Make your desired changes to the documents inside\n  [`/docs`](https://github.com/superfaceai/docs/tree/main/docs) directory\u003cbr /\u003e\n  It uses a standard Markdown syntax, but can be extended with custom React components via MDX.\n\n  \u003csup\u003e[Help for Markdown features ➚](https://docusaurus.io/docs/markdown-features)\u003c/sup\u003e\n\n- Put your static content (e.g. images) to\n  [`/static`](https://github.com/superfaceai/docs/tree/main/static) directory\u003cbr /\u003e\n  When linking to it from the docs, just drop `/static` from path, e.g. rendering `/img/diagram.png`\n  will render an image saved at `/static/img/diagram.png`.\n\n  \u003csup\u003e[Help for static assets ➚](https://docusaurus.io/docs/static-assets)\u003c/sup\u003e\n\n- Reference other docs via Markdown file path\u003cbr /\u003e\n  Linking to another document is preferably done via specifying the relative path to that\n  document (`./next-step.md`). Exceptions are pages placed in `src/pages/` directory that need\n  to be linked using their respective routes.\n\n  \u003csup\u003e[Help for referencing docs ➚](https://docusaurus.io/docs/docs-markdown-features#referencing-other-documents)\u003c/sup\u003e\n\n3. ### Update the content structure _(optional)_\n\n- **Page rename, new page, category; or change of structure**\u003cbr /\u003e\n  If you added a whole new category, page or simply want to change the table of contents,\n  you'll need to update [`sidebars.js`](https://github.com/superfaceai/docs/blob/main/sidebars.js).\n  It uses document IDs that are simply a path to the file minus the extension (unless explicitly\n  defined inside the document).\n\n  \u003csup\u003e[Help for Sidebar ➚](https://docusaurus.io/docs/sidebar)\u003c/sup\u003e\n\n- **Changing links in header navigation**\u003cbr /\u003e\n  Navigation links are defined in [`docusaurus.config.js`](https://github.com/superfaceai/docs/blob/main/docusaurus.config.js)\n  in `themeConfig.navbar.items` object.\n\n  \u003csup\u003e[Help for config ➚](https://docusaurus.io/docs/docusaurus.config.js)\u003c/sup\u003e\n\n4. ### Get the changes reviewed\n\n- When you're happy with your changes, open a PR and get it reviewed by someone.\u003cbr /\u003e\n  _Opening a PR will automatically deploy an online preview of your docs. It also verifies the build\n  doesn't contain any broken links._\n\n5. ### Deploy to production\n\n- Once your changes are verified and reviewed by another pair of eyes, it is ready to be merged to `main`.\u003cbr /\u003e\n  _Merging will automatically deploy `main` branch to production._\n\n## Tech Stack\n\nThese docs are built using [Docusaurus 3](https://docusaurus.io/).\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eDetails\u003c/strong\u003e\u003c/summary\u003e\n\nThe site is deployed on [Vercel](https://vercel.com/).\n\nAll deployments are automated via GitHub Actions and you can keep track of them\nin [the repository's environments](https://github.com/superfaceai/docs/deployments).\n\n- Preview: gets deployed for each PR\n- Production: gets deployed continuously from `main` branch\n\nEach deploy first verifies the validity of the build.\n\nIf you'd like to build locally:\n\n```bash\nyarn build\n```\n\n\u003c/details\u003e\n\n## License\n\nThe Superface documentation is licensed under a [Creative Commons Attribution 4.0 International license](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperfaceai%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuperfaceai%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperfaceai%2Fdocs/lists"}