Skip to content

Improve developer docs: fix bugs, restructure navigation, add new guides#249

Open
bking-va wants to merge 2 commits into
masterfrom
claude/sleepy-davinci-Pf58T
Open

Improve developer docs: fix bugs, restructure navigation, add new guides#249
bking-va wants to merge 2 commits into
masterfrom
claude/sleepy-davinci-Pf58T

Conversation

@bking-va

@bking-va bking-va commented Jun 8, 2026

Copy link
Copy Markdown

Summary

P0 — Bug fixes and content corrections

  • Fix content-type typo in advertising.yaml (vdnvnd) that would cause integration failures
  • Fix invalid JSON in code examples across campaignStats, socialProfiles, and SCIM guides
  • Fix Java syntax error in the OAuth token example (UsingAServiceAccount.md)
  • Fix typos across 8+ files — maintenance, products, lifecycle, fieldName, opportunity, crowd sourced, separate, referred, manageable, WordPress, and more
  • Replace stale "Coming Soon!" gRPC placeholder with link to the Vendasta APIs section
  • Add missing API descriptions to advertising and reputation OpenAPI specs

P1 — New documentation pages

  • Add API Architecture guide — explains the two API layers (gateway JSON:API vs service gRPC-translated) and when to use each
  • Add Error Reference — HTTP status codes, common error codes, error response format, and retry strategy with code example
  • Expand Request Format from 2 sentences to a full JSON:API reference (content types, resource structure, relationships, sparse fieldsets, filtering, pagination, sorting)
  • Add Quickstart guide — end-to-end "your first API call in 10 minutes" with Python + curl examples

P1 — Navigation restructure

  • Rename "Vendasta APIs" → "Service APIs" for clarity
  • *Rename cryptic "Wsp " entries → "Website Pro *" so external developers understand them
  • Rename "Crm" → "CRM (Extended)", "Vanalytics" → "Call Tracking & Analytics"
  • Move deprecated Business APIs from main navigation to new "Deprecated & Legacy" section
  • Add orphaned pages to TOC — RequestFormat.md, Errors.md, CRM-Overview.md were all invisible to users

P2 — Process improvements

  • Improve PR template with docs-specific checklist (TOC updated, JSON valid, links resolve, Spectral passes, changelog updated)

Test plan

  • Verify the Stoplight docs site renders correctly after merge
  • Confirm new TOC structure appears in sidebar: Overview section now has Quickstart → API Architecture → Request Format → Errors → Versioning → Change Log
  • Verify the "Service APIs" section renders with renamed entries (Website Pro, CRM Extended, Call Tracking)
  • Confirm "Deprecated & Legacy" section shows at the bottom with Business APIs and Legacy APIs
  • Check that the advertising.yaml content-type fix (application/vnd.api+json) renders properly
  • Verify JSON code examples parse correctly in the Stoplight try-it widget
  • Confirm internal links in new pages (Quickstart, API Architecture, Errors) resolve correctly

https://claude.ai/code/session_016Y8YdFJkcoTLKekSce4PrS

claude added 2 commits June 8, 2026 01:33
…ontent

- Fix content-type typo in advertising.yaml (vdn → vnd) that would break integrations
- Fix invalid JSON in code examples (campaignStats, socialProfiles)
- Fix Java syntax error in UsingAServiceAccount.md
- Fix typos across 8 files (maintenance, products, lifecycle, fieldName, opportunity, etc.)
- Fix escaped quote in SCIM guide JSON examples
- Fix garbled UUID in IDP-User-Sync.md example
- Add missing API descriptions to advertising and reputation OpenAPI specs
- Add Quickstart guide for new developers (end-to-end first API call)
- Expand RequestFormat.md from 2 sentences to full JSON:API reference
- Replace stale "Coming Soon" gRPC section with link to Vendasta APIs
- Add orphaned CRM-Overview.md to table of contents
- Fix duplicate filter parameter in connectedAccount guide

https://claude.ai/code/session_016Y8YdFJkcoTLKekSce4PrS
- Add API Architecture page explaining gateway APIs vs service APIs,
  helping developers understand which API layer to use
- Add Error reference page documenting HTTP status codes, error codes,
  error response format, and retry strategies with code example
- Add RequestFormat.md and Errors pages to TOC (were missing)
- Rename "Vendasta APIs" section to "Service APIs" for clarity
- Rename cryptic "Wsp *" entries to "Website Pro *" in TOC
- Rename "Crm" to "CRM (Extended)", "Vanalytics" to "Call Tracking & Analytics"
- Fix "Wordpress" capitalization to "WordPress"
- Move deprecated Business APIs from main navigation to
  new "Deprecated & Legacy" section alongside Legacy APIs
- Improve PR template with docs-specific checklist items
- Add cross-links from Quickstart to new Architecture and Errors pages

https://claude.ai/code/session_016Y8YdFJkcoTLKekSce4PrS
@bking-va bking-va changed the title Improve developer docs: fix bugs, add quickstart guide, expand thin content Improve developer docs: fix bugs, restructure navigation, add new guides Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants