wiremock/wiremock.org

EPIC: Restructure the examples to use code tabs

オープン

#183 opened on 2023/09/28

 (6 件のコメント) (0 件のリアクション) (0 人の担当者)HTML (72 件のフォーク)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (12 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Proposal

In WireMock documentation, there are A LOT of examples where JSON and Code examples are placed in separate examples which takes a lot of vertical space and complicates the documentation. Instead of that, it would be nice if the examples were put into recently introduced Code Tabs like this one:

image

Steps

Each case can be submitted as a separate pull request:

  • Find a case when two examples (usually JSON and Java) are placed sequentially
  • Merge examples into a single block using the {codetabs} macro
  • Copy-edit text around examples to ensure it is consistent

Example of a patch: https://github.com/wiremock/wiremock.org/pull/165

References

No response

コントリビューターガイド