Skip to content

Conversation

pwizla
Copy link
Collaborator

@pwizla pwizla commented Jul 8, 2021

What does it do?

  • Adds a responsive ::: api-call custom Markdown container and its ::: request and ::: response subcontainers
  • Applies these everywhere in the docs

Why is it needed?

In preparation for v4 docs, we're improving our VuePress stack with custom elements.

These custom Markdown containers will make the API-related docs more enjoyable with:

  • request and response visible at the same time
  • a proper visual identity for API calls, different from the tabs we use for other purposes
Screen.Recording.2021-07-07.at.19.19.17.mov

Notes

Design is still a work in progress. I received some feedback from our designers and will improve it.

To do:

  • test other color palettes
    • add some "Strapi touch" to the color palette :-)
  • check contrast ratio with tools like this one

@vercel
Copy link

vercel bot commented Jul 8, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/strapijs/documentation/8YNzjEY2WEMHS4yGxBswqystFQH2
✅ Preview: https://documentation-git-repo-api-enhancements-strapijs.vercel.app

@pwizla pwizla self-assigned this Jul 8, 2021
@pwizla pwizla added source: Dev Docs PRs/issues targeting the Developer Docs source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo internal PRs created by the Strapi core team labels Jul 8, 2021
@pwizla pwizla changed the title Repo/api enhancements Add custom Markdown container for API calls Jul 8, 2021
@pwizla pwizla mentioned this pull request Jul 20, 2021
@pwizla
Copy link
Collaborator Author

pwizla commented Jul 20, 2021

Closing in favor of #368

@pwizla pwizla closed this Jul 20, 2021
@pwizla pwizla deleted the repo/api-enhancements branch July 22, 2021 17:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal PRs created by the Strapi core team source: Dev Docs PRs/issues targeting the Developer Docs source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant