Skip to content

Rewrite README as a condensed reference - #2

Merged
breitburg merged 9 commits into
mainfrom
claude/readme-polish-cleanup-qed3n1
Aug 23, 2026
Merged

breitburg merged 9 commits into
mainfrom
claude/readme-polish-cleanup-qed3n1

Conversation

@breitburg

Copy link
Copy Markdown
Owner

Replace the exhaustive per-command reference (flag tables and full JSON
output samples for every command) with compact per-group command tables,
pointing at 'kuleuven docs' for the generated full surface. Fold the
concepts, cookie-storage, and conventions sections together, condense the
Python API method tables, and collapse the per-model subsections into a
short models overview. No behavior changes.

Co-Authored-By: Claude Fable 5 noreply@anthropic.com
Claude-Session: https://claude.ai/code/session_01MGFx1W4ZBjK3RnZ7L6VHfo

claude added 9 commits August 23, 2026 12:00
Replace the exhaustive per-command reference (flag tables and full JSON
output samples for every command) with compact per-group command tables,
pointing at 'kuleuven docs' for the generated full surface. Fold the
concepts, cookie-storage, and conventions sections together, condense the
Python API method tables, and collapse the per-model subsections into a
short models overview. No behavior changes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MGFx1W4ZBjK3RnZ7L6VHfo
Give every command its own subsection again with a worked example, but in
usage-focused prose: flag tables become sentences, output samples are
trimmed to what matters, and internals (SAML leg details, backend
architecture, per-model reference) are cut. No two code blocks are
adjacent, and paragraphs stay short.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MGFx1W4ZBjK3RnZ7L6VHfo
Open with what the project is for — giving AI agents access to KU Leuven —
and why the interface is shaped the way it is, before the mechanics.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MGFx1W4ZBjK3RnZ7L6VHfo
Reword every sentence that used them into plain sentences, commas, or
colons, including bullet lists and the example code comment.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MGFx1W4ZBjK3RnZ7L6VHfo
The intro describes what the project is again. A short 'AI agents'
subsection in Quickstart covers the JSON contract, kuleuven docs, and MCP
registration for Claude Desktop.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MGFx1W4ZBjK3RnZ7L6VHfo
Exit codes become one line under the CLI heading, credentials and cookie
storage move into 'session start', and the course-reference explanation
moves into the Toledo intro where <ref> is first used.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MGFx1W4ZBjK3RnZ7L6VHfo
The prose listing every method reads badly and the old snippet used a
nonexistent 'date' parameter. Show the real search_availability and
create_reservation flow instead, taking resource_name from the search
result, with the remaining methods mentioned in passing.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MGFx1W4ZBjK3RnZ7L6VHfo
The per-course data sentence and the downloads paragraph in the Python
API section were comma-separated method listings, same as the KurtClient
one. Both are now short code examples verified against the real
signatures, including the Path requirement of download_file_item.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MGFx1W4ZBjK3RnZ7L6VHfo
Global install becomes the primary path, with uv sync kept as the
from-source option for working on the project.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MGFx1W4ZBjK3RnZ7L6VHfo
@breitburg
breitburg merged commit 6de0d2f into main Aug 23, 2026
1 check failed
@breitburg
breitburg deleted the claude/readme-polish-cleanup-qed3n1 branch August 23, 2026 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants