{"id":21916512,"url":"https://github.com/codesignal/developer-docs","last_synced_at":"2025-04-18T21:56:00.033Z","repository":{"id":35238677,"uuid":"177754185","full_name":"CodeSignal/developer-docs","owner":"CodeSignal","description":"GraphQL API Docs","archived":false,"fork":false,"pushed_at":"2024-11-26T11:07:05.000Z","size":3588,"stargazers_count":0,"open_issues_count":6,"forks_count":3,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-11-26T12:20:46.655Z","etag":null,"topics":["api","codesignal","docs","documentation","graphdoc","graphql","graphqldoc"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CodeSignal.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":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-26T09:20:10.000Z","updated_at":"2024-11-26T11:07:08.000Z","dependencies_parsed_at":"2023-02-11T11:01:16.530Z","dependency_job_id":"3b176a69-ba3f-411f-8e3c-e9e1ee767fc3","html_url":"https://github.com/CodeSignal/developer-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/CodeSignal%2Fdeveloper-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeSignal%2Fdeveloper-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeSignal%2Fdeveloper-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeSignal%2Fdeveloper-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodeSignal","download_url":"https://codeload.github.com/CodeSignal/developer-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226971307,"owners_count":17711414,"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":["api","codesignal","docs","documentation","graphdoc","graphql","graphqldoc"],"created_at":"2024-11-28T19:18:16.335Z","updated_at":"2024-11-28T19:18:17.292Z","avatar_url":"https://github.com/CodeSignal.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CodeSignal Developer Docs\n\nA place to put documentation about interacting with our APIs.\n\n## Running locally\nYou can view the documentation site locally by running `npm start` -- you just need to have Python 2 installed on your local machine.\nThe start script serves the docs here: http://localhost:8000\n\nSince it's a static site, you can also just open `/docs/index.html` directly in a web browser if you prefer.\n\n## Modifying the event diagrams\n\nThe diagrams are generated using the following tool [diagrams](https://app.diagrams.net).\n\n1. Go to that specific URL.\n2. Select open existing diagram.\n3. Open `docs/diagrams/webhooks-flow.drawio` file.\n4. Make all the needed changes.\n5. Save the changes and put the resulting file on the repository to overwrite `docs/diagrams/webhooks-flow.drawio` file.\n\nTo update each image:\n\n1. Select everything you'd like to export. \n2. Click on File -\u003e Export -\u003e PNG.\n3. Make sure 'Selection Only' checkbox is checked.\n4. Overwrite the existing images with the new ones.\n\n## Generating GraphQL docs\nGraphQL API docs are generated with graphqldoc:\nhttps://github.com/codesignal/graphqldoc\n\nTo generate documentation:\n- The default endpoint is set to [http://app.codesignal.com/graphql](https://app.codesignal.com/graphql), so ensure that latest version is deployed already.\n- Check out this repository and run `npm install`, then `npm run build`.\n- Static pages will be generated under `/docs/graphql/types`.\n- Make sure they look okay, then commit and push.\n \n## How to publish updated docs\nThis repo is hosted with GitHub Pages, so any change under `/docs` on the `master` branch will be published here:\nhttps://codesignal.github.io/developer-docs/\nWhich in return should be redirected to this subdomain: developer.codesignal.com\n\nThat's it! You should see your changes there once they reach the master branch, as long as they are under `/docs`. \n\nDon't change the GraphQL `/docs/types/` pages manually, since your changes will be overwritten the next time those pages are generated.\nIt's okay to change other pages manually.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodesignal%2Fdeveloper-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodesignal%2Fdeveloper-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodesignal%2Fdeveloper-docs/lists"}