docs: rewrite the README for a first-time reader - #61
Open
JacobPEvans-personal wants to merge 1 commit into
Open
docs: rewrite the README for a first-time reader#61JacobPEvans-personal wants to merge 1 commit into
JacobPEvans-personal wants to merge 1 commit into
Conversation
The README assumed the reader already knew Splunk, Python packaging, and which port to connect to. It also described the test suites in prose, so running any of them meant reconstructing the environment variables from paragraphs. Rewritten for someone starting from nothing: what to install, how to connect, and one numbered section per test group with the exact variables and command to copy. Windows differences are a single table rather than a parallel set of instructions. Assisted-by: Claude:claude-fable-5 Claude-Session: https://claude.ai/code/session_0117oTjSHHjg1nh28LGRZ7My
JacobPEvans-personal
force-pushed
the
docs/readme-foolproof
branch
from
August 1, 2026 01:08
bb71faa to
b34064f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #60.
What
Rewrote
README.mdfor someone who has not used this tool, and may not know Splunk.8000instead of the management port8089..venv/bin/.Why
The old README assumed prior knowledge and described the test suites in prose, so running any of them meant reconstructing environment variables out of paragraphs. The write suite in particular needs fixture files staged inside the Splunk container, which was documented nowhere outside the CI workflow — so nobody could actually run it locally.
Proof
Claims in the README were checked, not assumed:
markdownlint-cli2and the full pre-commit hook set pass.Note
The Docker block for the write suite is transcribed from what CI actually does, including the fixture staging and the wait for first boot, so a local run matches the CI run step for step.