Skip to content

Commit

Permalink
docs(api): add api generator & document all exported symbols (#167)
Browse files Browse the repository at this point in the history
* add api generator & document all exported symbols

* add remaining docs to symbols

* set docs folder to docs

* link to api from readme

* fix cell provisioning strategy type
  • Loading branch information
jost-s authored Jan 19, 2023
1 parent cdcf849 commit 5e30fd1
Show file tree
Hide file tree
Showing 482 changed files with 8,688 additions and 678 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## \[Unreleased\]
### Added
### Removed
- API generation, available under ./docs
### Changed
### Fixed
- Cell provisioning strategy type in AppBundle.
### Removed
- TypeScript source maps.

## 2023-01-16: v0.11.13
### Fixed
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

A JavaScript client for the Holochain Conductor API (works with browsers as well as Nodejs).

> Holochain's Conductor API is under active development. This client package tracks that development fairly closely but sometimes gets behind.
[Complete API reference](./docs/client.md)

## Installation

Expand Down
34 changes: 34 additions & 0 deletions api-extractor.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
"bundledPackages": [],
"compiler": {},
"apiReport": {
"enabled": false
},
"docModel": {
"enabled": true,
"apiJsonFilePath": "<projectFolder>/docs/temp/<unscopedPackageName>.api.json"
},
"dtsRollup": {
"enabled": false
},
"tsdocMetadata": {},
"messages": {
"compilerMessageReporting": {
"default": {
"logLevel": "warning"
}
},
"extractorMessageReporting": {
"default": {
"logLevel": "warning"
}
},
"tsdocMessageReporting": {
"default": {
"logLevel": "warning"
}
}
}
}
20 changes: 0 additions & 20 deletions docs/API.md

This file was deleted.

247 changes: 0 additions & 247 deletions docs/API_adminwebsocket.md

This file was deleted.

Loading

0 comments on commit 5e30fd1

Please sign in to comment.