Skip to content

Documentation Improvements #525

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

Jump to bottom
Open
leeyi45 wants to merge 19 commits into
base: master
Choose a base branch
from
Open

Documentation Improvements #525

leeyi45 wants to merge 19 commits into from

Conversation

@leeyi45
Copy link
Contributor

@leeyi45 leeyi45 commented Jan 10, 2026

PR for a bunch of miscellaneous changes focused mainly around improving documentation.

  1. Type guards have their return types rendered as boolean in the documentation so as not to confuse cadets
  2. Code examples are validated via parser and ESLint to ensure that we don't get invalid code for code examples.
  3. Separate the two tsc functions into two different commands
  4. Fix markdown tree plugin not rendering certain examples correctly
  5. Update documentation

leeyi45 added 19 commits December 23, 2025 07:06
@leeyi45
Fix incorrect doc tags
282e8fc
@leeyi45
Add validation for example tags and hide type guards in generated docs
1f12e20
@leeyi45
Update docs about documentation
3370426
@leeyi45
Continue updating docs
175ab4e
@leeyi45
Add linting for code examples
1dd8cde
@leeyi45
Add compile command
bbc6970
@leeyi45
Fix bug where markdown directory trees weren't being aligned properly
5754a29
@leeyi45
Add tests for the markdown tree transformer
54c4eed
@leeyi45
Run format
49cbc9a
@leeyi45
Move buildtools to use tsc compile and typecheck separately
44d5dc3
@leeyi45
Add tests for ensuring that typedoc paths are processed correctly
ddcd384
@leeyi45
Add tests to ensure that typeguards are properly rendered
5a8b123
@leeyi45
Add the compile command to bundles
e87456f
@leeyi45
Update eslint-plugin-json version
8a1f40c
@leeyi45
Update code examples to comply with linting
68dee49
@leeyi45
Fix code example from plotly
989eba9
@leeyi45
Update vitest eslint plugin
f44cfba
@leeyi45
Change reference to tsc command to instead refer to compile command
d0b1422
@leeyi45
Fix incorrect eslint rules
7bca240
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@leeyi45