chore: add create-docs script and templates #4105
Merged
Conversation
This file contains 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
|
|
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dosubot
bot
added
the
size:L
github-actions
bot
added
the
Status: Do Not Merge
github-actions
bot
added
Type: Documentation
☁️ Nx Cloud ReportCI is running/has finished running commands for commit bdc60d5. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
|
Size Change: 0 B Total Size: 1.1 MB ℹ️ View Unchanged
|
Paste
|
||||||||||||||||||||||||
| Project |
Paste
|
| Run status |
|
| Run duration | 02m 04s |
| Commit |
|
| Committer | Nora Krantz |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
67
|
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit bdc60d5:
|
krisantrobus
approved these changes
Oct 16, 2024
PixeledCode
approved these changes
Oct 16, 2024
nkrantz
added
🚀 merge it!
🕵🏻♀️ Run website visual regression
Paste
|
||||||||||||||||||||||||
| Project |
Paste
|
| Run status |
|
| Run duration | 06m 05s |
| Commit |
|
| Committer | Nora Krantz |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
|
Failures
|
0
|
|
Flaky
|
0
|
|
Pending
|
0
|
|
Skipped
|
0
|
|
Passing
|
125
|
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.
In this PR
yarn create:docsto thepackage.jsonfile to create a docs directory and necessary filesplopfile.js(create-docs)docs-index.hbs,docs-api.hbs, anddocs-changelog.hbspackages/paste-website/src/pages/components/account-switcher/index.mdxfile to pull the package description from the package itself, meaning we now have a single source of truth for the package description (instead of 4). This file demonstrates the change needed to streamline the package description for all other packages. When anyone touches another website page (or just has free time/space in their PR), let's update the rest of the component website files with this same change.Limitations
There are certain places where I've added
TODO:s to the templates. They will require attention and slight changes after the script is run. (If you have the "TODO Highlight" VS Code extension installed, theTODO:s will all be highlighted and hard to miss.)titleCasewell, so in order for the website to build, there are a few places the case will need to be adjusted, or a space will need to be added (there's an open issue for this, I added a comment to it){{component-name}}). That prevents me from being able to add curly brackets to the plop templates without causing plop to fail. Because our LivePreview also uses double curly bracket notation (e.g.scope={{ComponentName}}), the brackets will have to be added after the script is runHow to test
If you want to give the new script a try to make sure it's working correctly, checkout this branch and delete an existing component's directory within
packages/paste-website/src/pages/componentsand run the script for that component. Make sure the website builds after running the script, and try giving the plop prompt different variations of the component name ("progress steps", "ProgressSteps", "progress-steps", etc).