blib-la / captain

Give your computer an AI Brain
https://get-captain.com
GNU Affero General Public License v3.0
52 stars 2 forks source link

chore: add documentation page #257

Closed pixelass closed 5 months ago

pixelass commented 5 months ago

Motivation

Prepares for a development documentation of Captain

In order to make the code compatible I had to change our typescript paths. The paths are now also more consistent but a bit longer as the @ prefix does not link to the root of each scope. Instead we use @/client, @/electron and @/shared. IMHO a reasonable tradeoff and also a bit more declarative. The adjustment was required to allow tsdoc to generate the markdown docs from our source-code/docblocks.

Issues closed

codacy-production[bot] commented 5 months ago

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
:white_check_mark: +0.00% (target: -1.00%) :white_check_mark: 100.00%
Coverage variation details | | Coverable lines | Covered lines | Coverage | | ------------- | ------------- | ------------- | ------------- | | Common ancestor commit (7e8de0eb860a700103f50d5c9834c3f8279f2690) | 1633 | 1496 | 91.61% | | | Head commit (40389e65112dc0f84a199f2a655313f436267162) | 1633 (+0) | 1496 (+0) | 91.61% (**+0.00%**) | **Coverage variation** is the difference between the coverage for the head and common ancestor commits of the pull request branch: ` - `
Diff coverage details | | Coverable lines | Covered lines | Diff coverage | | ------------- | ------------- | ------------- | ------------- | | Pull request (#257) | 35 | 35 | **100.00%** | **Diff coverage** is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: `/ * 100%`

See your quality gate settings    Change summary preferences

Codacy will stop sending the deprecated coverage status from June 5th, 2024. Learn more

TimPietrusky commented 5 months ago

:tada: This PR is included in version 1.0.0-alpha.63 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: