docs: align page layout docs with current public v4 page contract#78
Closed
docs: align page layout docs with current public v4 page contract#78
Conversation
Deploying qf-api-docs with
|
| Latest commit: |
dbf0c3f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://86d06c12.qf-api-docs.pages.dev |
| Branch Preview URL: | https://docs-page-layout-current-api.qf-api-docs.pages.dev |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7ce380116c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Collaborator
Author
|
Superseded by a new main-based docs sync now that the API exposes public v4/pages* endpoints. This PR documented the pre-parity state and is no longer the correct target. |
Member
|
Replacement PR: #90 This is the main-based docs sync that matches the now-public |
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
This is a docs-only sync to the current public
v4page-rendering contract.It removes unsupported public
v4/pages/lookupguidance and narrows the tutorial to the documented default-layout flow built around:GET /content/api/v4/chapters/{id}for chapter entry viachapter.pagesGET /content/api/v4/verses/by_page/{page_number}for known page renderingWhat Changed
docs/tutorials/fonts/page-layout.mdto document:GET /chapters/{id}andchapter.pagesGET /verses/by_page/{page_number}words=trueandline_numbercontent/api/v4/pages/lookuppages/layoutmushaf-basedby_pageusage as a documented public contractx-auth-tokenx-client-idchapter.pagesv4still does not expose general juz or arbitrary verse-range page lookupv4contractdocs/tutorials/fonts/font-rendering.mdFiles To Review
docs/tutorials/fonts/page-layout.mddocs/tutorials/fonts/font-rendering.mdOut Of Scope
quran.com-apidocs/content_apis_versionedopenAPI/content/v4.jsonWhy This Change
The previous tutorial documented unsupported public
v4page lookup paths and implied a broader page-layout contract than the public reference currently exposes. This PR narrows the guide to the documented public flow and makes the supported chapter-entry path discoverable.Validation
yarn build