Skip to content
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.

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

Teacher tool docs link updated #10149

Merged
merged 2 commits into from
Sep 3, 2024
Merged

Teacher tool docs link updated #10149

merged 2 commits into from
Sep 3, 2024

Conversation

srietkerk
Copy link
Contributor

Closes microsoft/pxt-microbit#5622

I wanted to bring up a couple of points here, as well.

  1. We have the TODO comment on this line. I'm wondering if we actually want to have an aka.ms link here instead or since the docs are complete we can remove the comment now?
  2. The docs link is "teacher tool" even though the tool to the public and even in the title is "Code Evaluation Tool". Should we rename the file to something like codeevaltool to accurately reflect it or is having the endpoint as teachertool fine?
  3. This doesn't have to be addressed now, but I'm also wondering the future of these docs. If we're hoping to ship the code eval tool with other targets in the future, are we going to have different docs in each target so we have the accurate theming in each or are we going to have the docs in a more global space like https://makecode.com/docs

@srietkerk srietkerk requested a review from a team September 3, 2024 21:55
Copy link
Collaborator

@ganicke ganicke left a comment

Choose a reason for hiding this comment

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

I imagine this should migrate to ./common-docs/teachertool with images overridden in the target...eventually.

Copy link
Contributor

@thsparks thsparks left a comment

Choose a reason for hiding this comment

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

To your questions:

  1. TODO comment: I think we can just remove this comment for now.
  2. "Teacher tool" vs "Code Evaluation Tool" in link: We probably should adjust this eventually, but it can be a separate change.
  3. Future of these docs: I agree with @ganicke's comment on this.

@srietkerk srietkerk merged commit 4742c98 into master Sep 3, 2024
7 checks passed
@srietkerk srietkerk deleted the srietkerk/tt-docs branch September 3, 2024 22:36
abchatra pushed a commit that referenced this pull request Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Teacher Tools: Shows 'Sorry, the page is missing' when click 'Learn More'
4 participants