Repository navigation
docs: tighten new-user wording across landing, getting-started, and FAQ - #10
Merged
Merged
Conversation
…and FAQ Make the first-touch copy more concise and friendlier: - Landing tagline and cards lead with what KSI does, not the framework label; drop wordy card fragments. - README intro matches the landing tagline's phrasing. - Getting started: split two run-on paragraphs (sample-output note, knowledge DB check) into shorter sentences. - FAQ: answer "in one sentence" as one sentence, de-jargon the "what problem" answer, and turn the "when NOT to use" wall of text into a scannable list.
Make custom-task data prep easier to follow: - Record schema: lead with what's required vs. optional so the minimum is clear before the full annotated example. - repo/ contract: drop internal 'seam' jargon and simplify the phrasing. - 12-file capture caveat: split the wall of text into two paragraphs, surface the 12-file number, and list the skipped files cleanly.
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
2 participants
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.
What this is
A wording-focused pass over the docs pages a new user hits first, plus a
follow-up smoothing the bring-your-own-tasks data-prep read. The goal was to
make the descriptions concise and friendly, without changing any technical
meaning, anchors, or code samples.
Commit 1 — new-user wording
Landing page (
docs/index.md)the lessons…") instead of the "generational orchestration framework" label.
"no dataset or loader code needed."
benchmark, evaluator, runtime, or improvement strategy with one
register_*call each.
README intro
Getting started (
docs/getting-started.md)clearly.
FAQ (
docs/faq.md)short follow-up.
bullets.
Commit 2 — bring-your-own-tasks data prep (
docs/your_own_tasks.md)clear before the full annotated example.
repo/contract: dropped internal "seam" jargon and simplified phrasing.surfaced the 12-file number, and listed the skipped files cleanly.
Not touched
The deeper reference pages (architecture, improvement strategies, adding a
benchmark/evaluator) were left as-is — their density suits their audience.
No anchors, headings, links, or code blocks changed, so cross-page links stay
intact.