docs icon indicating copy to clipboard operation
docs copied to clipboard

Feature request: Code blocks should have filenames

Open qwikag opened this issue 9 months ago • 1 comments

This is just an example page: https://docs.amplify.aws/cli/graphql/data-modeling/#model-directive

The problem with reading these docs is the code and the config run together in a blur. Some code snippets look like config snippets and vice versa.

So there is a need to have a file name at the top of a section of config or code and show that it is preceded by other code of config and or followed by other code/config. this way when reading the docs we are able to tell what we are looking at.

All through these amplify docs, this is an extensive issue: image

https://docs.amplify.aws/cli/graphql/data-modeling/#model-directive


Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

This guide can be confusing when it walks us through a GraphQL schema example and a client-code example, where providing sample filenames such as schema.graphql can provide additional context without the need for describing where we need to write this sample.

Describe the solution you'd like A clear and concise description of what you want to happen.

image

https://www.christopherbiscardi.com/the-quick-guide-to-serverless image

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

https://github.com/aws-amplify/amplify-category-api/issues/1675

qwikag avatar Sep 27 '23 08:09 qwikag