Skip to content

API Documentation Update#1

Open
faris0x wants to merge 3 commits intoquran:mainfrom
faris0x:main
Open

API Documentation Update#1
faris0x wants to merge 3 commits intoquran:mainfrom
faris0x:main

Conversation

@faris0x
Copy link
Copy Markdown

@faris0x faris0x commented Oct 16, 2023

Made the API documentation for Quran.com more readable and easy to understand.

I have no idea what is going on in line 2116 (https://api-docs.quran.com/docs/quran.com_versioned/translation). Very incoherent and the API request seems to fail no matter what I put into the required parameter
Basically done
@vercel
Copy link
Copy Markdown

vercel bot commented Oct 16, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
qf-api-docs ❌ Failed (Inspect) Oct 18, 2023 8:40pm

Comment thread openAPI/quran.com/v4.json Outdated
"minimum": 1,
"maximum": 114,
"description": "The number of the chapter"
"description": "The number of the chapter (surah)"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Surah" and "Ayah" should be capitalized. This applies to all the changes so will leave just 1 comment for all.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Semi-complete. I will triple check my work tomorrow

Comment thread openAPI/quran.com/v4.json Outdated
Comment thread openAPI/quran.com/v4.json Outdated
Comment thread openAPI/quran.com/v4.json Outdated
Comment thread openAPI/quran.com/v4.json Outdated
"Audio"
],
"description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a Hizb.",
"description": "Get list of audio files for a verse (ayah) from a reciter, specified by their Reciter ID (see https://api-docs.quran.com/docs/quran.com_versioned/chapter-reciters)..",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an extra "." at the end.

Comment thread openAPI/quran.com/v4.json Outdated
Comment thread openAPI/quran.com/v4.json
Comment thread openAPI/quran.com/v4.json Outdated
"Quran"
],
"description": "Get a single #model:XCinMTfQdCrC3D3vH of all ayah.\n\nSee #endpoint:N4JAF8phDshhyrBHs endpoint to fetch available translations.\n\nYou can also include more fields of translation using `fields` query string.",
"description": "Get a single translation of the Qur'an\n\nUse https://api-docs.quran.com/docs/quran.com_versioned/translations to get the ID a desired translation",
Copy link
Copy Markdown
Member

@osamasayed osamasayed Oct 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Throughout the docs, we should use relative path and not full path and let Docusaurus resolve the link by itself which would be relative to the current directory for example, https://api-docs.quran.com/docs/quran.com_versioned/translations should be converted into [link](./translations) which would still be resolved to whatever directory and domain the current docs portal is one. This is more sustainable for the future.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not finished 100%

Not done fixing, DO NOT MERGE PR
@faris0x
Copy link
Copy Markdown
Author

faris0x commented Oct 18, 2023

I made some fixes tonight, but IT IS NOT READY! PLEASE DON'T MERGE THE PR
Jazakallah

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