Conversation
cmsetzer
approved these changes
May 14, 2026
cmsetzer
left a comment
cmsetzer
left a comment
Contributor
There was a problem hiding this comment.
Nice. I took just docs-serve for a test drive, looking good.
Minor language issue since these are public-facing docs: what do you think about rewording the tagline The missing changelog for datasets? It is catchy but reads slightly weird in that Binoc isn't "the changelog" itself, it produces the changelog. Maybe something like
- Binoc: Generate the missing changelog for any dataset
- Binoc: A tool to generate the missing changelog for datasets
- etc.?
Collaborator
Author
|
Fixed tests! Let's not solve the tagline question right now, TBD. :) |
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.
This merges various docs-like objects we had into a MkDocs + Material** site deployed to `https://harvard-lil.github.io/binoc/ , with a vaguely Diátaxis approach. Much of the content I confess is AI decision making; once we have the framework we should iterate on content.
This includes merging in various existing docs -- docs/tutorial.md, readme.md, docs/writing_plugins.md, the ADRs; auto-generating code docs; and writing new explanation/how-to/reference docs.
Also a substantive fix to match the python sdk to the underlying api, which the docs surfaced as not matching.