feat(nx-dev): split devkit reference page

[isaacplmann]

• Splits the devkit reference page into many pages (one page per object)
• Some types that were previously listed only as Object are now actually documented
• No redirects needed since the entry point pages remain the same
• The pages for individual types and functions are not listed in map.json so we don't have to manually update that file any time the code changes. The link checker was updated to account for that

Question:
The ngcli_adapter items are nested under ngcli_adapter in the breadcrumbs. Should I do the same thing for devkit? This will add a redirect, but that's not a big deal. I only hesitated to do that because the breadcrumb would be devkit > documents > devkit > someFunction which looks weird.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nx-dev	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 9, 2023 7:07pm

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 4ee3af3. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 7 targets

• linux nx affected --target=e2e --base=e57d42cf09bcec38a0c82b4d958d23e2e7ee53ef --head=4ee3af3ca76b7da975c9656f4968c27981ac1573 --parallel=1
• linux nx run-many -t check-imports check-commit check-lock-files check-codeowners documentation --parallel=1 --no-dte
• linux nx affected --target=build --base=e57d42cf09bcec38a0c82b4d958d23e2e7ee53ef --head=4ee3af3ca76b7da975c9656f4968c27981ac1573 --parallel=3
• linux nx affected --target=lint --base=e57d42cf09bcec38a0c82b4d958d23e2e7ee53ef --head=4ee3af3ca76b7da975c9656f4968c27981ac1573 --parallel=3
• linux nx affected --target=test --base=e57d42cf09bcec38a0c82b4d958d23e2e7ee53ef --head=4ee3af3ca76b7da975c9656f4968c27981ac1573 --parallel=1
• nx-cloud record -- nx format:check --base=e57d42cf09bcec38a0c82b4d958d23e2e7ee53ef --head=4ee3af3ca76b7da975c9656f4968c27981ac1573
• linux nx documentation --no-dte

---

Sent with 💌 from NxCloud.

[FrozenPandaz]

https://nx-dev-git-fork-isaacplmann-docs-split-devkit-reference-nrwl.vercel.app/packages/devkit/documents/ExecutorContext#target

Is it possible to get the type information in the table of contents as well? I think it would be helpful to see all the types in a single fold. Most of them are hopefully self explanatory once the reader knows the type so they don't have to click to find out the type of the property.

[juristr]

Much better than before. I agree with Jason's comment, maybe enriching the TOC with some further info could be helpful.

Also, I get this is ref docs, but I'm wondering whether it would make sense to categorize the TOC not based on the type (which I understand can be done automatically right now), but rather categorize by when you'd need them. Like working with files, project config, templating,... Just a thought 🤔

[isaacplmann]

I'll merge this and make a follow up PR with improvements

[github-actions]

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.