Conversation
|
linting is failinf |
|
@Uzlopak can we unblock this PR so we can land it? |
|
"Hi, I'd like to work on this issue. I'll submit a PR shortly." |
GO FOR IT 🎉 |
There was a problem hiding this comment.
Pull request overview
Fixes documentation navigation by reformatting the (previously malformed) table of contents in docs/Reference/Server.md, and makes minor spacing adjustments in docs/Reference/TypeScript.md.
Changes:
- Rewrites the
Server.mdTOC into valid Markdown list structure and aligns several headings/anchors for improved navigation. - Adjusts some heading labels/levels within
Server.md(e.g., “Server Methods and Attributes”,listenTextResolvernesting). - Adds blank lines in a numbered list in
TypeScript.mdfor readability.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/Reference/TypeScript.md | Adds blank lines within a numbered list (formatting-only). |
| docs/Reference/Server.md | Rebuilds malformed TOC and updates related headings/anchors. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| - [onProtoPoisoning](#onprotopoisoning) | ||
| - [onConstructorPoisoning](#onconstructorpoisoning) | ||
| - [logger](#logger) | ||
| - [loggerInstance](#loggerInstance) |
There was a problem hiding this comment.
The TOC entry for loggerInstance links to #loggerInstance, but there is no element with id="loggerInstance" in this document (the heading slug is #loggerinstance, and the explicit anchor is #factory-logger-instance). This link will be broken on GitHub-rendered Markdown; update the fragment to match an existing anchor (e.g., #loggerinstance or #factory-logger-instance).
| - [loggerInstance](#loggerInstance) | |
| - [loggerInstance](#factory-logger-instance) |
| - [setNotFoundHandler](#setnotfoundhandler) | ||
| - [setErrorHandler](#seterrorhandler) | ||
| - [setChildLoggerFactory](#setchildloggerfactory) | ||
| - [setGenReqId](#setGenReqId) |
There was a problem hiding this comment.
The TOC entry for setGenReqId points to #setGenReqId, but the section uses <a id="set-gen-req-id"></a> and the heading slug would be #setgenreqid. As written, this fragment won't resolve; update the TOC link to match an existing anchor.
| - [setGenReqId](#setGenReqId) | |
| - [setGenReqId](#set-gen-req-id) |
| `json2ts` is a CLI utility included in `json-schema-to-typescript`. `schemas` | ||
| is the input path, and `types` is the output path. | ||
|
|
||
| 5. Run `npm run compile-schemas`. Two new files should have been created in the | ||
| `types` directory. | ||
|
|
||
| 6. Update `index.ts` to have the following code: |
There was a problem hiding this comment.
This PR is described as fixing a malformed TOC in docs/Reference/Server.md, but it also changes docs/Reference/TypeScript.md (adds blank lines in the numbered list). If that change is intentional, please mention it in the PR description; otherwise, consider reverting it to keep the PR scoped to the stated goal.
Currently the TOC is malformed: