Skip to content

docs: Add tutorials/README file #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
esthersweon wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Add tutorials/README file #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions tutorials/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Tutorials

We provide stand-alone example apps in **Python** and **JavaScript** that demonstrate how Knowledge Graph data can be applied to different use cases.

## Prerequisites

- A [Learning Commons Platform](https://platform.learningcommons.org/) account
Copy link
Copy Markdown

@hlsearl hlsearl May 29, 2026

Choose a reason for hiding this comment

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

Do we need to spell both of these out. To get the API key, you have to have the account. I'd been shortening these 2 point to jus the API key bullet with a link to the platform.

Copy link
Copy Markdown

@aml25 aml25 May 29, 2026

Choose a reason for hiding this comment

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

yeah I love this idea

- An API key generated in the Learning Commons Platform

## Tutorials

See the README in each tutorial folder for language-specific setup instructions.

> **Note:** These tutorials use the Knowledge Graph REST API, which is currently available as Early Access and is actively evolving. Breaking changes may occur as we expand capabilities and improve reliability.

| Tutorial | Description | Python | JavaScript |
| :------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------- | :------------------------------------ |
| [compare_standards](./compare_standards/) | Compare standards between Common Core (CCSSM) and state frameworks using crosswalk data, Jaccard scores, and learning components | [python/](./compare_standards/python/) | [js/](./compare_standards/js/) |
| [generate_prereq_practice](./generate_prereq_practice/) | Generate prerequisite-based practice questions by querying standards, learning progressions, and learning components | [python/](./generate_prereq_practice/python/) | [js/](./generate_prereq_practice/js/) |
| [working_with_standards](./working_with_standards/) | Query state educational standards by jurisdiction, grade level, and type | [python/](./working_with_standards/python/) | [js/](./working_with_standards/js/) |
Loading