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.

Sign up for GitHub

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

Jump to bottom

“Reference guide” has no content #126

Closed
smockle opened this issue Mar 5, 2021 · 2 comments
Closed

“Reference guide” has no content #126

smockle opened this issue Mar 5, 2021 · 2 comments

Comments

@smockle
Copy link
Contributor

smockle commented Mar 5, 2021

Repro’d in Safari 14.0.3 and Chrome 89.0.4389.82

e.g. https://github.github.io/catalyst/reference/#attr just says:

Reference guide

Reference guide

Find the reference guide for all our exported functions below

Screenshot of the empty reference guide page on the Catalyst docs site
@keithamus
Copy link
Member

Looks like our tsdoc tooling broke somehow.

TBH I think we shouldn't bother fixing this. It wasn't that useful and recent Experience Surveys highlighted as much.

The Experience Surveys also highlighted how the guide can be a little wordy and it'd be nice to offer a "Cheat sheet" style quick reference, almost like a flash card to remind folks of syntax & shape without describing detailed semantics, so this seems like a blessing in disguise, I vote we delete the Reference page and add a Cheat Sheet page instead. We could probably just make one large code sample and leverage the new docs annotations to provide useful context on-focus.

@koddsson koddsson mentioned this issue Mar 29, 2021
Merged
@Nickel-Less Nickel-Less mentioned this issue Mar 29, 2021
Closed
@keithamus
Copy link
Member

Fixed by #130

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@keithamus @smockle