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

fix: refactor docs to use package specific structure #446

Merged
merged 1 commit into from
May 31, 2023
Merged

Conversation

agdimech
Copy link
Contributor

Refactors the documentation to merge all docs given the required structure from the docs folder within a PDKProject.

The new structure is as follows:

docs
  /developer_guides/{package-name}/(*.md | .pages.yml)
  /faqs/{package-name}/index.md
  /walkthroughs/{package-name}/(*.md | .pages.yml)
  /assets/{package-name}/* [Optional if images need to be rendered from guides]

@nx-cloud
Copy link

nx-cloud bot commented May 31, 2023

☁️ Nx Cloud Report

Attention: This version of the Nx Cloud GitHub bot will cease to function on July 1st, 2023. An organization admin can update your integration here.

CI is running/has finished running commands for commit 72bbc74. 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 2 targets

Sent with 💌 from NxCloud.

@cogwirrel
Copy link
Member

New docs site looks beautiful! 😄

@cogwirrel cogwirrel merged commit a558c8b into mainline May 31, 2023
4 checks passed
@cogwirrel cogwirrel deleted the fix/docs branch May 31, 2023 05:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants