[PR] docs: move user documentation into docs/ for website hosting [skywalking-nodejs]

["wu-sheng (via GitHub)" <gi...@apache.org>]

wu-sheng opened a new pull request, #145:
URL: https://github.com/apache/skywalking-nodejs/pull/145

   ## Motivation
   
   All Node.js Agent documentation lived in a single ~190-line `README.md`, so it could not be imported by the SkyWalking website like the Python, Go, and Rust agent docs are. This splits it into a `docs/` tree the website can render.
   
   ## What changed
   
   - **`docs/README.md`** — overview page (`/readme` in the sidebar), **`docs/menu.yml`** — website sidebar.
   - **`docs/en/`** — 14 pages: setup (quick start, configuration, start and stop), features (tracing, runtime metrics), plugins (supported libraries, AWS SDK v2), advanced use (serverless, webpack, troubleshooting), contribution (build and test, plugin development, release).
   - **`README.md`** — now a short entry point: requirements, install, quick start, links into `docs/`.
   - **`CONTRIBUTING.md`** — points at the build, plugin development, and release guides.
   - **`docs/How-to-release.md`** — kept as a stub with the `#vote-check` heading, so the footnote in previously sent `[VOTE]` emails still lands somewhere useful.
   - **`scripts/release.sh`** — the `[VOTE]` email now cites in-tarball doc paths (`docs/` ships inside the source package), replacing links to a `CONTRIBUTING.md` anchor that this PR removes.
   
   Layout follows `apache/skywalking-python` and `apache/skywalking-go`.
   
   ## Accuracy
   
   Content was checked against the source rather than copied forward:
   
   - Every `SW_*` variable read anywhere in `src/` is documented, and nothing is documented that the agent does not read.
   - Two long-standing README errors are corrected: `SW_AGENT_INSTANCE` defaults to the host name (not a random value, `AgentConfig.ts`), and `SW_AGENT_LOGGING_LEVEL` defaults to `error` (not `info`, `logging/index.ts`).
   - `SW_AGENT_TRACE_TIMEOUT` is documented as the gRPC deadline for trace reports, meter reports, and service management requests, which is where it is actually used.
   - Meter table, webpack static-loader plugin list, AWS SDK v2 plugin behavior, and the build/test commands match `src/` and `.github/workflows/test.yaml`.
   
   ## Follow-up
   
   Rendering on the website needs a companion PR in `apache/skywalking-website` adding `repoUrl` and a `Next` entry for the Node.js Agent in `data/docs.yml` — without `repoUrl` the doc importer skips the repository.
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] docs: move user documentation into docs/ for website hosting [skywalking-nodejs]

["wu-sheng (via GitHub)" <gi...@apache.org>]

wu-sheng merged PR #145:
URL: https://github.com/apache/skywalking-nodejs/pull/145


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org