Skip to content

fix: docs quality fixes — parse errors, error guide links, moderation APIs#343

Merged
ketanyekale merged 1 commit intomainfrom
docs/restapi-chatapi-ENG-30061-ketan
Apr 27, 2026
Merged

fix: docs quality fixes — parse errors, error guide links, moderation APIs#343
ketanyekale merged 1 commit intomainfrom
docs/restapi-chatapi-ENG-30061-ketan

Conversation

@ketanyekale
Copy link
Copy Markdown
Contributor

Summary

Fixes multiple documentation quality issues discovered during a comprehensive docs audit.

Parse Error Fixes (14 files)

  • Fixed unclosed <br> tags in flutter-sdk-changes-review.md (286 tags)
  • Fixed mismatched code fences (3 vs 4 backticks) across 10 JS SDK and iOS notification files
  • Fixed escaped MDX comment syntax in sdk/javascript/send-message.mdx
  • Removed duplicate frontmatter description keys in 2 files
  • Removed invalid import ... from 'mintlify' statements from 13 files

Moderation API Fixes

  • Moved moderation endpoints from management-apis.json to chat-apis.json (correct host)
  • Added 10 missing moderation endpoints (reasons, flagged-messages, reviewed-messages)
  • Updated 13 MDX frontmatter paths to match OAS spec

Error Guide Link Fixes (243 files)

  • Management APIs (127 files): /articles/error-guide/rest-api/management-apis/error-codes
  • Notifications APIs (49 files): /articles/error-guide/rest-api/notifications-apis/error-codes
  • AI Agent Builder APIs (58 files): /articles/error-guide/rest-api/ai-agents-apis/error-codes
  • BYO AI Agent APIs (9 files): /articles/error-guide/rest-api/byo-ai-agents-apis/error-codes

Other

  • Removed duplicate redirect source in docs.json
  • Removed AWSCLIV2.pkg (46MB) from repo, added *.pkg to .gitignore

What was tested

  • All 14 parse error files verified clean (fences matched, tags balanced, frontmatter valid)
  • All 23 moderation MDX pages verified matching OAS paths
  • All 243 error guide links verified pointing to correct section-specific pages
  • Mintlify preview deployment validated

Updated error guide links in Management APIs (127), Notifications
APIs (49), AI Agent Builder APIs (58), and BYO AI Agent APIs (9)
to point to their section-specific error codes pages instead of
the generic /articles/error-guide.
@ketanyekale ketanyekale merged commit 785ba73 into main Apr 27, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants