lightninglabs / lightninglabs/lightning-api-ng
docs: add .md accessible versions of API pages
Open
Nobody has claimed this yet.
LLM
- Dominant language
- Go
- Stars
- 6
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
To make our docs more easily legible for LLMs and coding agents. We should add the ability to append `.md` onto any path, and have that produce a raw markdown version. This'll make it easy to point an LLM at our docs, or just copy paste for easier access.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named. First locate the API documentation route or page generator and trace how a requested path is rendered; then verify that appending `.md` to any API documentation path returns raw Markdown without changing the normal page response.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100