Skip to content

Commit e2e1fa7

Browse files
authored
docs: add steps to package packages and reference for local development (#2437)
1 parent dcda03d commit e2e1fa7

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

.github/maintainers_guide.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,37 @@ Test code should be written in syntax that runs on the oldest supported Node.js
2424

2525
We have included `launch.json` files that store configuration for `vscode` debugging in each package. This allows you to set breakpoints in test files and interactively debug. Open the project in `vscode` and navigate to the debug screen on the left sidebar. The icon for it looks like a little lock bug with an x inside. At the top in `vscode`, select the configuration to run and press the green play icon to start debugging. Alternatively, on mac, you can press `cmd + shift + d` to get to the debug screen and `F5` to start debugging. If you are using `vscode` debugging, don't forget to lint the source (`npm run lint`) manually.
2626

27+
### 🧰 Local Development
28+
29+
Using in progress changes made to this package in an app can be useful for development. Use the pack command to package a particular SDK package. For example:
30+
31+
```sh
32+
cd packages/web-api
33+
npm pack
34+
```
35+
36+
Install the `slack-web-api-*.tgz` to an app to use your changes:
37+
38+
```sh
39+
npm install path/to/node-slack-sdk/packages/slack-web-api-*.tgz
40+
```
41+
42+
The packaged build includes dependencies published with each package, including required peer dependencies but not devDependencies, to imitate actual installations.
43+
44+
Remove cached project dependencies with `rm -r node_modules package-lock.json` between those steps to keep the cache clean.
2745

2846
### 📄 Managing Documentation
2947

30-
See the [Docs README](https://github.com/slackapi/node-slack-sdk/blob/main/docs/README.md) for information on how the docs site work.
48+
The reference docs for each package is independent of the others. They're generated using the `typedoc` and `typedoc-plugin-markdown` packages with the configurations of the package's `typedoc.json` file.
49+
50+
Each package has a script to these generate reference docs. For example:
3151

32-
The reference docs for each package is independent of the others. They're generated using `typedoc` and `typedoc-plugin-markdown`. In each package's `package.json` there's a `docs` command that generates reference docs for that package based on the configuration settings found in `/package-name/typedoc.json`.
52+
```sh
53+
cd packages/web-api
54+
npm run docs
55+
```
3356

34-
The script places the reference markdown files in `/reference/package-name`.
57+
The script places the reference markdown files in `/docs/english/reference/package-name`.
3558

3659
### 🚀 Releases
3760
_For beta releases, see [**Beta Releases**](https://github.com/slackapi/node-slack-sdk/blob/main/.github/maintainers_guide.md#-beta-releases) section below_

0 commit comments

Comments
 (0)