Document how to run the static file, ETag, and Range demo

Open Beginner friendly
  • Is something wrong?
#43 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
86/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Read examples/README.md, examples/http_entity_static/app.py, examples/http_entity_static/client_http1.py, and the checked-in examples/http_entity_static/public/hello.txt fixture. From the repository root, document how to start the server and run the client in separate terminals, then describe the initial GET (200), conditional GET (304), and byte-range request (206). Done when the commands work against the fixture and the walkthrough is added.

Written by the indexing model from the issue text.

Description

good first issue

The examples index identifies the static entity demo and the pairing matrix lists its app and client. Add a short walkthrough so a contributor can run the pair locally.

Acceptance criteria

  • Show the commands to start the example server and run the existing client from the repository root in a second terminal.
  • Describe the three requests and their expected statuses: 200 for the initial GET, 304 for the conditional GET, and 206 for the byte range.
  • Run the documented commands against the checked-in hello.txt fixture.

Relevant files

Dominant language
Python
Stars
3
Forks
3
Avg merge
7h 59m
Merged PRs (30d)
8

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from tigrbl/tigrcorn

All issues in tigrbl/tigrcorn

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.