Skip to content

Commit

Permalink
doc: migrate from api-documenter to typedoc (#119)
Browse files Browse the repository at this point in the history
  • Loading branch information
divdavem committed Dec 22, 2023
1 parent 0cea4d2 commit 966cc4c
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 49 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ computing the total price

Note that even when the quantity is 0, the total is recomputed when the unit price changes.

In Tansu, while the same [derived](https://amadeusitgroup.github.io/tansu/tansu.derived.html) function is still available, the [computed](https://amadeusitgroup.github.io/tansu/tansu.computed.html) function is also available, with which it is only necessary to provide a function, and the list of dependencies is detected automatically and dynamically:
In Tansu, while the same [derived](https://amadeusitgroup.github.io/tansu/functions/derived.html) function is still available, the [computed](https://amadeusitgroup.github.io/tansu/functions/computed.html) function is also available, with which it is only necessary to provide a function, and the list of dependencies is detected automatically and dynamically:

```typescript
import {writable, computed} from '@amadeus-it-group/tansu';
Expand Down Expand Up @@ -115,7 +115,7 @@ Process end

The fullName store successively went through different states, including an inconsistent one, as `Sherlock Lupin` does not exist! Even if it can be seen as just an intermediate state, it is **fundamental** for a state management to only manage consistent data in order to prevent issues and optimize the code.

In Tansu, the [batch function](https://amadeusitgroup.github.io/tansu/tansu.batch.html) is available to defer **synchronously** (another important point) the derived (or computed) calculation and solve all kind of multiple dependencies issues.
In Tansu, the [batch function](https://amadeusitgroup.github.io/tansu/functions/batch.html) is available to defer **synchronously** (another important point) the derived (or computed) calculation and solve all kind of multiple dependencies issues.

The previous example is resolved this way:

Expand Down
139 changes: 94 additions & 45 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
"@angular/platform-browser-dynamic": "^17.0.6",
"@commitlint/cli": "^18.4.3",
"@commitlint/config-conventional": "^18.4.3",
"@microsoft/api-documenter": "^7.23.14",
"@microsoft/api-extractor": "^7.38.5",
"@rollup/plugin-typescript": "^11.1.5",
"@typescript-eslint/eslint-plugin": "^6.13.2",
Expand All @@ -26,6 +25,7 @@
"rollup": "^4.7.0",
"rxjs": "^7.8.1",
"svelte": "^4.2.8",
"typedoc": "^0.25.4",
"typescript": "^5.2.2",
"vitest": "^1.0.2",
"zone.js": "^0.14.2"
Expand All @@ -43,7 +43,7 @@
"build": "npm run clean && npm run build:rollup && npm run build:dts && npm run build:api && npm run build:package",
"format:check": "prettier --check .",
"format:fix": "prettier --write .",
"docs": "api-documenter markdown -i temp -o dist/docs"
"docs": "typedoc"
},
"husky": {
"hooks": {
Expand Down
9 changes: 9 additions & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"entryPoints": ["src/index.ts"],
"excludeInternal": true,
"excludePrivate": true,
"kindSortOrder": ["Function", "Class"],
"out": "./dist/docs",
"tsconfig": "./tsconfig.d.json",
"visibilityFilters": {}
}

0 comments on commit 966cc4c

Please sign in to comment.