Style and tweak hookdoc output #482
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
* Uses a layout.tmpl override * Uses a specific README file for home content * Includes a 10up-specific stylesheet (in progress)
jeffpaul
added
needs:documentation
helen
changed the title
|
I'm sure I could futz with how it looks all day, but I think it's at least decent looking now. Design team may want to come in and save us someday but not too bad for basic developer docs :) Home
Hook
|
Closed
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.
Description of the Change
Leverages JSdoc config to do the following:
Alternate Designs
See #481, #480
Benefits
Can explain what this site is for, point to other resources, and make it look nice and 10uppy.
Possible Drawbacks
More maintenance?
Verification Process
npm run build:docslocallyChecklist:
Applicable Issues
See #387. Also noticed in working on this that the docblocks still need some more work, in particular naming params and adding
@returnsto filters so they are separated from actions.