litespeedtech / litespeedtech/lsquic
Move build documentation to readthedocs.io
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 1.9k
- Forks
- 397
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 8
Description
Instead of documenting build information in README.md and BUILD-WINDOWS.md, we should create a new .rst document so that it can be hosted along with the other docs on https://lsquic.readthedocs.io
The build chapter should cover:
- Building on Linux
- Building on Windows
- Building using Docker
- Building library only (without example programs, in order not to depend on libevent)
- Building shared library
This is a good starter project for a new contributor.
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
Start by reading README.md and BUILD-WINDOWS.md, then inspect the existing Read the Docs documentation structure at lsquic.readthedocs.io to choose the new .rst document location. Done means the build chapter covers Linux, Windows, Docker, library-only builds without libevent, and shared-library builds, and is included with the hosted documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, docker
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100