Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(core): powerpack docs #27904

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

docs(core): powerpack docs #27904

wants to merge 9 commits into from

Conversation

isaacplmann
Copy link
Collaborator

Infrastructure for powerpack docs

  • Adds the ability to generate API docs from ocean packages
  • Creates placeholder pages for plugin overview docs
  • Creates placeholder pages for powerpack features

To generate API documentation for plugins in the ocean repository, run the nx documentation command with the NX_OCEAN_RELATIVE_PATH environment variable set to the relative path to your checked out copy of the ocean repo.

NX_OCEAN_RELATIVE_PATH=../ocean nx documentation

This will create generated API documentation in the docs/external-generated folder. This API will be merged into the normal docs/generated documentation when the docs site is built.

Because there are two separate output folders, if someone runs nx documentation without the NX_OCEAN_RELATIVE_PATH environment variable, the ocean documentation will not be overwritten. The ocean documentation will only be updated or deleted when someone explicitly chooses to do so.

@isaacplmann isaacplmann added the PR status: do not merge This will block a PR from being merged until this tag is removed. label Sep 13, 2024
@isaacplmann isaacplmann requested review from a team as code owners September 13, 2024 14:07
Copy link

vercel bot commented Sep 13, 2024

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

Name Status Preview Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview Sep 19, 2024 9:37pm

Adds an activate powerpack recipe page
Documents the powerpack-owners plugin

- Creates a plugin overview page
- Create a feature page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR status: do not merge This will block a PR from being merged until this tag is removed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants