docs: Update main README, datasets/README, and evals/README for consistency#86
Merged
Conversation
…consistent headers (no extra bolding)
esthersweon
changed the title
esthersweon
changed the title
esthersweon
changed the title
hlsearl
reviewed
May 29, 2026
hlsearl
reviewed
May 29, 2026
| Annotators were provided with specific assumptions about the student, text and information to score. These and other details are included in the [project docs](https://docs.learningcommons.org/evaluators/literacy-evaluators/literacy-evaluators#expert-annotated-benchmark-datasets). | ||
| ## License | ||
|
|
||
| [License](https://github.com/learning-commons-org/evaluators/blob/main/LICENSE.md) |
Contributor
There was a problem hiding this comment.
Question. Does Mintlify link here for licenses as well? Or are we maintaining 2 versions of this info?
Contributor
Author
There was a problem hiding this comment.
We are maintaining 2 versions – Mintlify links to this license page.
I agree that we should choose one:
- Keep the
LICENSE.mdfile in GH + change Mintlify's link to go straight to this file - Keep the Mintlify page and simply link to it from this README and/or the
LICENSE.mdfile
Where do we prefer that licensing information live?
hlsearl
reviewed
May 29, 2026
hlsearl
reviewed
May 29, 2026
adnanrhussain
approved these changes
Jun 10, 2026
adnanrhussain
left a comment
adnanrhussain
left a comment
Contributor
There was a problem hiding this comment.
LGTM. Some feedback to resolve before merging.
Looking forward to the root README cleanup
| Download link: [Learning Commons annotations of CLEAR for qualitative text complexity v1.0 2025-09-02.csv](https://aidt-evaluators-files-public-prod.s3.us-west-2.amazonaws.com/Learning+Commons+annotations+of+CLEAR+for+qualitative+text+complexity+v1.0+2025-09-02.csv) | ||
| > NOTE: If text was not annotated for a given column, it will contain the value `not scored`. | ||
|
|
||
| License: [https://github.com/learning-commons-org/evaluators/blob/main/LICENSE.md](https://github.com/learning-commons-org/evaluators/blob/main/LICENSE.md) |
Contributor
There was a problem hiding this comment.
P0 - Lets make sure we keep the license.md. Please confirm with Trust
Contributor
Author
There was a problem hiding this comment.
Kept the link later in this file.
Will confirm with Trust that we want to keep in this repo.
| | Subject Matter Knowledge | [Jupyter Notebook](./smk_evaluator.ipynb) | [Prompts](./prompts/subject-matter-knowledge/) | | ||
| | Conventionality | [Jupyter Notebook](./conventionality_evaluator.ipynb) | [Prompts](./prompts/conventionality/) | | ||
| | Purpose | [Jupyter Notebook](./purpose_evaluator.ipynb) | [Prompts](./prompts/purpose/) | | ||
| | Text complexity (combo) | [Jupyter Notebook](./text_complexity_combo.ipynb) | | |
Contributor
There was a problem hiding this comment.
P1 - Remove the Text complexity line. I will be removing this notebook in the next iteration
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
4 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.
Changes
Main
README(Checklist)datasets/README(Checklist)evals/README(Checklist)JIRA
https://czi.atlassian.net/browse/XP-1158