Skip to content

docs: rebuild bilingual documentation - #4

Merged
RlxChap2 merged 2 commits into
mainfrom
docs/rebuild-bilingual-documentation
Sep 9, 2026
Merged

docs: rebuild bilingual documentation#4
RlxChap2 merged 2 commits into
mainfrom
docs/rebuild-bilingual-documentation

Conversation

@RlxChap2

@RlxChap2 RlxChap2 commented Sep 9, 2026

Copy link
Copy Markdown
Member

Closes: #3

Summary

  • Rebuild the documentation around a bilingual locales/ structure for English and Arabic.
  • Document all 31 supported GET operations with generated OpenAPI contracts, endpoint pages, SDK guidance, and diagrams.
  • Preserve legacy documentation URLs through redirects while keeping language navigation and RTL behavior consistent.
  • Add source-aware generation, validation, link checking, and CI coverage for documentation changes.

Validation

  • pnpm check
  • pnpm build
  • pnpm broken-links
  • node scripts/check-source.mjs <Bonyan-API> <bonyan-sdk-js>

@RlxChap2 RlxChap2 self-assigned this Sep 9, 2026
@RlxChap2 RlxChap2 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 9, 2026
@RlxChap2
RlxChap2 merged commit af9f121 into main Sep 9, 2026
3 checks passed
@RlxChap2
RlxChap2 deleted the docs/rebuild-bilingual-documentation branch September 9, 2026 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] API docs base URL doesn't match the actual running API path

1 participant