wiremock/wiremock.org

EPIC: Restructure the examples to use code tabs

開放

#183 建立於 2023年9月28日

 (6 則留言) (0 個反應) (0 位負責人)HTML (72 個分叉)auto 404
documentationenhancementgood first issue

倉庫指標

星標
 (12 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

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

貢獻者指南