haskell-servant / haskell-servant/servant

servant-docs Table of contents

Open
#1,164 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Haskell
Stars
2k
Forks
427
Avg merge
2d 23h
Merged PRs (30d)
5

Description

I'm rendering a list of method + path as table of contents at the top of my api docs.

Which looks like:
* [POST /auth/login](#POST-authlogin)
* [POST /auth/logout](#POST-authlogout)
* [GET /sites](#GET-sites)
* [POST /sites](#POST-sites)
* [DELETE /sites/:sId](#DELETE-sitessId)
* [GET /sites/:sId](#GET-sitessId)
* [PATCH /sites/:sId](#PATCH-sitessId)
* ...

I saw the interest in #37.

I'd say my current style isn't very skim friendly as stuff doesn't line up. It's the same as the titles of each endpoint. What would be the ideal style/layout of the table of contents?

Contributor guide

Open the contributing guide

Research direction

Review the proposed table of contents in this issue and the interest noted in #37. Clarify and agree on a skim-friendly layout for method-and-path endpoint entries; the work is done when the expected style is decided and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.