Repository navigation
docs: fix stale unit-test anchors and API reference build command - #11585
Open
ZainnQureshii wants to merge 1 commit into
Open
ZainnQureshii wants to merge 1 commit into
ZainnQureshii wants to merge 1 commit into
Conversation
Point the CONTRIBUTING and PR template links at the existing #unit-testing section, and replace the removed npm typedoc scripts with the core-api-docs Nx target, which writes to dist/api-reference. Fixes NativeScript#11448 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Checklist
Docs-only change, so no tests were added and the unit suite was not run. The new build command and output path are taken from the target's config files cited below; the docs build itself was not run.
What is the current behavior?
As described in #11448, a few contributor docs point at things that no longer exist:
tools/notes/CONTRIBUTING.md:72linksDevelopmentWorkflow.md#running-unit-tests, and the PR template linksDevelopmentWorkflow.md#running-unit-tests-application. Neither heading exists; the section is## Unit Testing(tools/notes/DevelopmentWorkflow.md:24).tools/notes/DevelopmentWorkflow.mdsays to runnpm run typedoc(output inbin/dist/apiref) andnpm run dev-typedoc. Neither script is inpackage.json.What is the new behavior?
#running-unit-testsand#running-unit-tests-application->#unit-testing.npm run typedoc->npx nx build core-api-docs, thebuildtarget of thecore-api-docsproject, whichnpm startlists (tools/workspace-scripts.js:117-119). It runstools/scripts/build-docs.sh, whose typedoc config writes todist/api-reference(tools/scripts/tsconfig.typedoc.json:25), so the output path changes frombin/dist/apireftodist/api-reference.npm run dev-typedocparagraph is removed; there is no dev-server target for the API docs.Fixes #11448.
Prepared with AI assistance (Claude Code) and reviewed with GitHub Copilot.
🤖 Generated with Claude Code