Skip to content

Conversation

@daisyfaithauma
Copy link
Contributor

Summary

  • headers glossary initial documentation

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@github-actions github-actions bot added product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ size/s labels Nov 18, 2024
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Nov 18, 2024

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: a428eee
Status: ✅  Deploy successful!
Preview URL: https://e16c79cc.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://aig-glossary.cloudflare-docs-7ou.pages.dev

View logs

@github-actions
Copy link
Contributor

@kathayl
Copy link
Contributor

kathayl commented Nov 18, 2024

  1. can we increase the width of column one so the lines don't wrap for the header?
  2. rename columns from Term --> Header and Definition --> Description
  3. do we need to repeat "AI Gateway" in each description? This glossary is within AI Gateway docs so i would hope they know what we're referring to
  4. can the deprecated headers be it's own separate table?
  5. Reword description --> "AI Gateway supports a variety of headers to help you configure, customize, and manage your API requests. This page provides a complete list of all supported headers, along with a short description"
  6. can we link each header to the specific part of each page it's on?

@daisyfaithauma
Copy link
Contributor Author

  1. can we increase the width of column one so the lines don't wrap for the header?
  2. rename columns from Term --> Header and Definition --> Description
  3. do we need to repeat "AI Gateway" in each description? This glossary is within AI Gateway docs so i would hope they know what we're referring to
  4. can the deprecated headers be it's own separate table?
  5. Reword description --> "AI Gateway supports a variety of headers to help you configure, customize, and manage your API requests. This page provides a complete list of all supported headers, along with a short description"
  6. can we link each header to the specific part of each page it's on?
  1. We can't adjust this table unfortunately.
  2. Researching on how to do this because a glossary is more like a changelog in format (also for 4)
  3. yes will do

@kathayl
Copy link
Contributor

kathayl commented Nov 22, 2024

  1. Move the header hierarchy info to the bottom of the page because the main point of this page is the glossary. So it should be a) intro paragraph about headers b) the table c) followed by the configuration hierarchy
    --> The page should start with
    "AI Gateway supports a variety of headers to help you configure, customize, and manage your API requests. This page provides a complete list of all supported headers, along with a short description"

  2. IS the spacing of the numbered list in "configuration hierarchy" correct? seems like there's a lot of empty space between each number

@daisyfaithauma daisyfaithauma enabled auto-merge (squash) November 22, 2024 19:07
@daisyfaithauma daisyfaithauma merged commit 9d84806 into production Nov 22, 2024
12 checks passed
@daisyfaithauma daisyfaithauma deleted the aig-glossary branch November 22, 2024 21:12
harshil1712 pushed a commit that referenced this pull request Dec 3, 2024
* headers glossary initial documentation

* minor changes

* Update glossary.mdx

* added links

* added links

* added header hierachy docs

* spelling

* added links

* Moved hierarchy info

---------

Co-authored-by: Kathy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants