This PR introduces a lot of changes in documentation, tests and configurations, overview below:
1. Documentation and typedoc
From now on, typedoc is generated correctly for all packages, and I also added vuepress, which allows you to create your own documentation (not generic).
To generate documentation use pnpm docs-build, this will generate static .html files in the <root>/docs directory along with the api directory which contains the typedoc documentation.
To check its operation, it can be served locally, use pnpm docs-serve, port 8080.
This is caused by the use of the @kayahr/jest-electron-runner package, which for some reason does not want to work.
I refer you to the discussion in which we decide what to do next: https://github.com/xeokit/sdk/discussions/21
Summary report: work in progress
3. Base configuration and clean-up
From now on, we have the packages/config package, which contains the base tsconfig files and configuration files in other packages inherit from them. The same goes for Jest configuration. This is where linter and formatter configurations will be found in the future.
Hello!
This PR introduces a lot of changes in documentation, tests and configurations, overview below:
1. Documentation and typedoc
From now on, typedoc is generated correctly for all packages, and I also added vuepress, which allows you to create your own documentation (not generic).
To generate documentation use
pnpm docs-build, this will generate static.htmlfiles in the<root>/docsdirectory along with theapidirectory which contains thetypedocdocumentation. To check its operation, it can be served locally, usepnpm docs-serve, port8080.The documentation is located in the
packages/docspackage. Just edit the.mdfiles, more here: https://v2.vuepress.vuejs.org/guide/introduction.html2. Tests
Most tests work, a few require fixing the tested code. I haven't been able to resolve test issues in these packages yet:
@xeokit/treeview @xeokit/viewer @xeokit/dotbim @xeokit/bcf
This is caused by the use of the
@kayahr/jest-electron-runnerpackage, which for some reason does not want to work. I refer you to the discussion in which we decide what to do next: https://github.com/xeokit/sdk/discussions/21Summary report: work in progress
3. Base configuration and clean-up
From now on, we have the
packages/configpackage, which contains the base tsconfig files and configuration files in other packages inherit from them. The same goes for Jest configuration. This is where linter and formatter configurations will be found in the future.