Add docs - #6
Merged
Merged
Conversation
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 pull request significantly expands the documentation for the evaluation framework, adding conceptual guides and clarifying the motivation, design, and behavior of the library. The changes introduce new documentation pages covering evaluation-driven development, alignment strategies, feature rules, metrics, and logging, while also updating the
README.mdto better explain the library's purpose. Additionally, a GitHub Actions workflow is added to automate documentation builds and deployment.Documentation Improvements:
Added new conceptual documentation pages:
Updated
README.mdto clarify the motivation for the library, the evaluation-driven development loop, and how the library fits into real-world workflows.Automation:
.github/workflows/docs.yml) to build and deploy documentation automatically on pushes and pull requests.