Clean up README and other documentation#45
Merged
nathanjcochran merged 13 commits intomainfrom Oct 7, 2025
Merged
Conversation
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. |
Askir
approved these changes
Oct 7, 2025
Contributor
Askir
left a comment
There was a problem hiding this comment.
Looks great. Just small comments.
Using "Tiger" without specifying Tiger Data or Tiger Cloud or Tiger CLI by itself feels odd to me.
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>
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.
This cleans up the README in preparation for making the repo public.
In particular, it:
docs/development.mdfile (which is still referenced from the "Contributing" section of the README).I also moved some other files into the new
docsfolder (in particular,DECISIONS.mdandCODE_REVIEW.md) and removed theTODO.mdfile (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.mdfile (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.