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

Data Module: Move the data reference to the root level #7627

Merged
merged 2 commits into from
Jun 29, 2018

Conversation

youknowriad
Copy link
Contributor

This PR fixes the data module docs by moving them to the root level of the handbook. Even if the handbook supports nested levels, it doesn't look good.

Also tries to fix the links in the table of contents and use a "trick" to make them work in both github and the handbook.

@youknowriad youknowriad added the [Type] Developer Documentation Documentation for developers label Jun 29, 2018
@youknowriad youknowriad self-assigned this Jun 29, 2018
@youknowriad youknowriad requested a review from a team June 29, 2018 09:23
- [**core/edit-post**: The Editor's UI Data](../../docs/data/core-edit-post.md)
- [**core/viewport**: The viewport module Data](../../docs/data/core-viewport.md)
- [**core/nux**: The NUX (New User Experience) module Data](../../docs/data/core-nux.md)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the trick, I saw it used elsewhere, not certain how it works though.

Copy link
Member

@tofumatt tofumatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, just a note about newlines in prose.

@@ -154,6 +167,20 @@ saved state of the post.

Post attribute value.

### getAutosaveAttribute

Returns an attribute value of the current autosave revision for a post, or
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned to @aduth, I think it's better if we don't put newlines in our prose for markdown. It makes it harder to refactor/type/diff, and I don't really think it improves readability (people reading in 80-character windows will/should have wrapping on 🤷‍♂️).

@youknowriad youknowriad merged commit 1f20cf8 into master Jun 29, 2018
@youknowriad youknowriad deleted the fix/data-module-docs branch June 29, 2018 10:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants