search

bigcommerce / docs

The open source docs home for BigCommerce, including API specifications in OAS YAML and narrative docs in MDX
https://developer.bigcommerce.com
11 stars 20 forks source link

Feedback for “Schemas” #202

Open electricenjindevops opened 3 months ago

electricenjindevops commented 3 months ago

On the schemas documentation we are unable to click the arrows to see more info for array / object structures.

examples:

https://developer.bigcommerce.com/docs/storefront/stencil/themes/context/object-reference/schemas#category

I am using Chrome (latest version) on Windows 10.

slsriehl commented 3 months ago

Hi @electricenjindevops -- thanks for developing with BC and opening this issue. This work is ticketed and planned, and I'm going to leave this issue open until it's resolved.

electricenjindevops commented 3 months ago

Thanks Sarah, much appreciated! This may or may not be related, but we were also unable to see meta description in the Category object schema on a Stencil theme template recently. This is what caused us to view the docs in the first place - we'll review this again soon, but wondering if maybe the two issues are related potentially.

On Mon, Apr 1, 2024 at 12:30 PM 'Sarah Riehl' via DevOps < @.***> wrote:

Hi @electricenjindevops https://github.com/electricenjindevops -- thanks for developing with BC and opening this issue. This work is ticketed and planned, and I'm going to leave this issue open until it's resolved.

— Reply to this email directly, view it on GitHub https://github.com/bigcommerce/docs/issues/202#issuecomment-2030108777, or unsubscribe https://github.com/notifications/unsubscribe-auth/AZUTVRFBJ7V6NRPYTAEPSOTY3GDTVAVCNFSM6AAAAABFNNAWUGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMZQGEYDQNZXG4 . You are receiving this because you were mentioned.Message ID: @.***>

slsriehl commented 2 months ago

@electricenjindevops There actually isn't any more detail in the schema as we have it now, so this isn't a problem with the docs per se (although they are part of the solution!). I did make a small adjustment to the source file, which you can see in the merged PR above, but it doesn't yet add any of the detail you're after.

We'll make sure there's an open ticket for the engineering group that manages Stencil to check out the issue with meta, as well as a docs ticket to add more detail.