Improve developer docs: fix bugs, restructure navigation, add new guides#249
Open
bking-va wants to merge 2 commits into
Open
Improve developer docs: fix bugs, restructure navigation, add new guides#249bking-va wants to merge 2 commits into
bking-va wants to merge 2 commits into
Conversation
…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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
P0 — Bug fixes and content corrections
vdn→vnd) that would cause integration failuresP1 — New documentation pages
P1 — Navigation restructure
P2 — Process improvements
Test plan
application/vnd.api+json) renders properlyhttps://claude.ai/code/session_016Y8YdFJkcoTLKekSce4PrS