{"id":31718678,"url":"https://github.com/speakeasy-api/developer-docs","last_synced_at":"2025-10-09T02:54:50.497Z","repository":{"id":279393797,"uuid":"925340300","full_name":"speakeasy-api/developer-docs","owner":"speakeasy-api","description":"This documentation is open source. We welcome feedback, suggestions, and PRs","archived":false,"fork":false,"pushed_at":"2025-10-07T17:35:14.000Z","size":263219,"stargazers_count":9,"open_issues_count":1,"forks_count":7,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-10-07T19:18:35.843Z","etag":null,"topics":["api","docs","mcp","openapi","speakeasy-api"],"latest_commit_sha":null,"homepage":"https://www.speakeasy.com/docs","language":"MDX","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/speakeasy-api.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":".github/CODEOWNERS","security":null,"support":"docs/supported/openapi.mdx","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-01-31T17:34:44.000Z","updated_at":"2025-10-07T17:35:17.000Z","dependencies_parsed_at":"2025-08-25T21:18:36.847Z","dependency_job_id":"f7592dba-a071-4d55-a454-a8f7dc092e1d","html_url":"https://github.com/speakeasy-api/developer-docs","commit_stats":null,"previous_names":["speakeasy-api/developer-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/speakeasy-api/developer-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fdeveloper-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fdeveloper-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fdeveloper-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fdeveloper-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/speakeasy-api","download_url":"https://codeload.github.com/speakeasy-api/developer-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/speakeasy-api%2Fdeveloper-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000731,"owners_count":26082906,"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","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","docs","mcp","openapi","speakeasy-api"],"created_at":"2025-10-09T02:54:49.030Z","updated_at":"2025-10-09T02:54:50.491Z","avatar_url":"https://github.com/speakeasy-api.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Contributing to Speakeasy Documentation\n\nWelcome to the Speakeasy documentation repository! This guide will help you contribute to our open-source documentation.\n\n## 📂 Repository Structure\n\nThe documentation is organized into several content hubs:\n\n- [`api-design/`](https://www.speakeasy.com/api-design) - API design guidelines and best practices\n- [`docs/`](https://www.speakeasy.com/docs) - Core product documentation\n- [`guides/`](https://www.speakeasy.com/guides) - Step-by-step product guides\n- [`mcp/`](https://www.speakeasy.com/mcp) - MCP hub\n- [`openapi/`](https://www.speakeasy.com/openapi) - OpenAPI hub\n\n## ✍️ How to Edit Content\n\n### 1. Locate the File\n\nThe documentation files in this repository directly map to the URLs on our website. To find the file you want to edit:\n\n1. Take the URL path after `speakeasy.com/`\n2. Add `.mdx` to the end\n3. That's your file path in the repository\n\nFor example:\n\n- Website URL: `https://www.speakeasy.com/docs/prep-openapi/linting`\n  - File path: `docs/prep-openapi/linting.mdx`\n\n### 2. Make Your Changes\n\n- Use MDX (`.mdx`) when you need React components, or Markdown (`.md`) for simple content\n- Follow our quick style guide below\n- Include proper meta descriptions for SEO\n- Optimize images using Next.js Image component\n\n### 3. Submit Your Changes\n\n1. Create a new branch for your changes\n2. Commit with a descriptive message following [Conventional Commits](https://www.conventionalcommits.org/)\n   - Example: `chore: update authentication guide`\n3. Create a pull request\n4. Once approved, your changes will be merged\n\n## 📝 Quick Style Guide\n\n### Writing Style\n\n- Use clear, concise language\n- Write in active voice\n- Keep explanations brief and direct\n- Use American English\n\n### Code and Links\n\n- Use code blocks for code snippets\n- Add language specification to code blocks\n- Use relative URLs: `[link](/docs/create-client-sdks)`\n- Place code references in backticks\n\n### Formatting\n\n- Use sentence case for headings\n- Use proper heading hierarchy\n- Include code examples where relevant\n- Add proper meta descriptions for SEO\n\n## 🚀 Getting Started\n\n1. Fork the repository\n2. Clone your fork:\n\n   ```bash\n   git clone https://github.com/YOUR_USERNAME/developer-docs.git\n   ```\n\n3. Create a new branch:\n\n   ```bash\n   git checkout -b docs/your-change\n   ```\n\n4. Make your changes\n5. Submit a pull request\n\n## 🤝 Need Help?\n\n- Open an issue for general questions\n- Join our [Slack community](https://join.slack.com/t/speakeasy-dev/shared_invite/zt-1cwb3flxz-lS5SyZxAsF_3NOq5xc8Cjw) for real-time help\n- Check existing issues and pull requests for similar questions\n\nThank you for contributing to our documentation! Your help makes our documentation better for everyone.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-api%2Fdeveloper-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeakeasy-api%2Fdeveloper-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeakeasy-api%2Fdeveloper-docs/lists"}