docs(config): improve profile descriptions #10517

lidel · 2024-09-17T15:01:55Z

Improves docs related to profiles:

fixed callouts
each profile now has a linkable section
made it more clear that badgerv1 is legacy that should be avoided (cc @gammazero)
move profiles and types to the end for better ux

docs/config.md

Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com>

docs(config): improve profile descriptions

8ca5a25

lidel added the skip/changelog This change does NOT require a changelog entry label Sep 17, 2024

lidel requested a review from gammazero September 17, 2024 15:01

chore: move profiles and types to the end

4236207

lidel marked this pull request as ready for review September 17, 2024 15:21

lidel requested a review from a team as a code owner September 17, 2024 15:21

lidel mentioned this pull request Sep 17, 2024

Release 0.31 #10499

Closed

34 tasks

lidel requested a review from 2color September 17, 2024 15:23

lidel mentioned this pull request Sep 17, 2024

Badger2 integration #7705

Closed

2color reviewed Sep 17, 2024

View reviewed changes

docs/config.md Show resolved Hide resolved

2color approved these changes Sep 17, 2024

View reviewed changes

chore: update docs/config.md [skip ci]

8bba273

Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com>

lidel merged commit 60588af into master Sep 20, 2024

lidel deleted the docs/improved-profile-descriptions branch September 20, 2024 13:40

Provide feedback