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

Initial commit to bring in the docs #2733

Merged
merged 24 commits into from
Jun 27, 2023
Merged

Initial commit to bring in the docs #2733

merged 24 commits into from
Jun 27, 2023

Conversation

HarelM
Copy link
Collaborator

@HarelM HarelM commented Jun 27, 2023

This is related to #2150.
It only adds the relevant parts to this repo as a commit that won't affect anything at that point.
After this I'll create a branch the will allow to slowly convert the tsdocs.
Once all the docs are converted we will be able to merge this branch and create a new documentation site.

Things that were added as part of this PR:

  1. mkdocs config file
  2. docs generation script
  3. images generation script
  4. All the examples are now part of this repo for both documentation and debugging.
  5. some lint fixes

How to review this:
You can ignore the html and png files as they were copied as is from the docs repo.
Other files (~10) are the interesting stuff.

build/generate-docs.ts Dismissed Show dismissed Hide dismissed
@codecov-commenter
Copy link

codecov-commenter commented Jun 27, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (6a939ed) 73.82% compared to head (0acad39) 73.82%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2733   +/-   ##
=======================================
  Coverage   73.82%   73.82%           
=======================================
  Files         238      238           
  Lines       18952    18952           
  Branches     4276     4276           
=======================================
  Hits        13991    13991           
  Misses       4961     4961           
Impacted Files Coverage Δ
src/ui/control/fullscreen_control.ts 75.51% <ø> (ø)
src/index.ts 81.48% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@HarelM HarelM marked this pull request as ready for review June 27, 2023 11:35
@HarelM HarelM requested review from birkskyum and rotu June 27, 2023 11:55
docs/README.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
typedoc.json Outdated Show resolved Hide resolved
@HarelM HarelM merged commit 3f8560d into main Jun 27, 2023
13 checks passed
@HarelM HarelM deleted the typedoc-1.0 branch June 27, 2023 20:19
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.

3 participants