Skip to content

Clean up README and other documentation#45

Merged
nathanjcochran merged 13 commits intomainfrom
nathan/clean-up-readme
Oct 7, 2025
Merged

Clean up README and other documentation#45
nathanjcochran merged 13 commits intomainfrom
nathan/clean-up-readme

Conversation

@nathanjcochran
Copy link
Member

This cleans up the README in preparation for making the repo public.

In particular, it:

  • Moves most internal development info out of the README and into a new docs/development.md file (which is still referenced from the "Contributing" section of the README).
  • Moves the "installation instructions and "Quick Start" to the top of the README
  • Explains the MCP server and how to install it
  • Documents all of the available commands and MCP tools
  • Documents all of the configuration options, env vars, and flags

I also moved some other files into the new docs folder (in particular, DECISIONS.md and CODE_REVIEW.md) and removed the TODO.md file (which looked stale/outdated to me, especially now that we're tracking everything in Linear). I figure we want the top-level to be as clean and organized as possible.

Finally, I made a bunch of updates to the CLAUDE.md file (which is still at the top-level). Some of it was just getting existing information accurate and up-to-date (like the project structure/architecture), and the rest was to reflect new patterns and additions to the codebase (like the MCP server and the release pipeline).

Open to any and all feedback on this!

Closes AGE-127.

@nathanjcochran nathanjcochran self-assigned this Oct 6, 2025
@linear
Copy link

linear bot commented Oct 6, 2025

AGE-127 Tiger CLI: Clean up repo and make it public

We intend to open-source this. Before making the repo public, we should make sure everything is in a good state (READMEs and other documentation are up-to-date and accurate, etc.)

See also this Slack conversation.

Copy link
Contributor

@cevian cevian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great

Copy link
Contributor

@Askir Askir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Just small comments.

Using "Tiger" without specifying Tiger Data or Tiger Cloud or Tiger CLI by itself feels odd to me.

nathanjcochran and others added 10 commits October 7, 2025 11:20
Co-authored-by: Matvey Arye <cevian@gmail.com>
Signed-off-by: Nathan Cochran <nathanjcochran@gmail.com>
Co-authored-by: Matvey Arye <cevian@gmail.com>
Signed-off-by: Nathan Cochran <nathanjcochran@gmail.com>
Co-authored-by: Jascha Beste <bestejascha@gmail.com>
Signed-off-by: Nathan Cochran <nathanjcochran@gmail.com>
Co-authored-by: Jascha Beste <bestejascha@gmail.com>
Signed-off-by: Nathan Cochran <nathanjcochran@gmail.com>
Co-authored-by: Jascha Beste <bestejascha@gmail.com>
Signed-off-by: Nathan Cochran <nathanjcochran@gmail.com>
Co-authored-by: Jascha Beste <bestejascha@gmail.com>
Signed-off-by: Nathan Cochran <nathanjcochran@gmail.com>
Co-authored-by: Jascha Beste <bestejascha@gmail.com>
Signed-off-by: Nathan Cochran <nathanjcochran@gmail.com>
@nathanjcochran nathanjcochran merged commit 2b8a05f into main Oct 7, 2025
1 check passed
@nathanjcochran nathanjcochran deleted the nathan/clean-up-readme branch October 7, 2025 16:14
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.

3 participants