techdocs: Add changeset for all three packages

This commit is contained in:
Himanshu Mishra
2020-12-05 18:36:50 +01:00
parent 372160ede5
commit dae4f39838
3 changed files with 49 additions and 1 deletions
+3 -1
View File
@@ -4,6 +4,7 @@ Common functionalities for TechDocs, to be shared between techdocs plugins and t
This package is used by `techdocs-backend` to serve docs from different types of publishers (Google GCS, Local, etc.).
It is also used to build docs and publish them to storage, by both `techdocs-backend` and `techdocs-cli`.
## Usage
Create a preparer instance from the [preparers available](/packages/techdocs-common/src/stages/prepare) at which takes an Entity instance.
@@ -11,6 +12,7 @@ Run the [docs generator](/packages/techdocs-common/src/stages/generate) on the p
Publish the generated directory files to a [storage](/packages/techdocs-common/src/stages/publish) of your choice.
Example:
```js
async () => {
const preparedDir = await preparer.prepare(entity);
@@ -26,7 +28,7 @@ async () => {
entity: entity,
directory: resultDir,
});
}
};
```
## Features