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

Cleanup documentation #8702

Merged
merged 3 commits into from Nov 12, 2022
Merged

Cleanup documentation #8702

merged 3 commits into from Nov 12, 2022

Conversation

danog
Copy link
Collaborator

@danog danog commented Nov 12, 2022

No description provided.

@danog danog marked this pull request as ready for review November 12, 2022 12:37
@danog danog added the release:internal The PR will be included in 'Internal changes' section of the release notes label Nov 12, 2022
@muglug muglug merged commit 98a5dc3 into vimeo:master Nov 12, 2022
@muglug
Copy link
Collaborator

muglug commented Nov 12, 2022

I've separately removed a few unnecesary navigation sections in Markdown, since the psalm.dev/docs generator provides those:

Screenshot 2022-11-12 at 2 59 30 PM

@danog
Copy link
Collaborator Author

danog commented Nov 12, 2022

I've separately removed a few unnecesary navigation sections in Markdown

Looks OK for the subtype pages, but could you revert this for https://psalm.dev/docs/annotating_code/type_syntax/atomic_types/?

The link color, while being IMO very pleasant and noticeable when used next to normal text, is less obvious in the main atomic type list, and I think it does not make it clear that the links are actually links.

The first times I came across the type reference page, I thought there was no detailed documentation about the types themselves, and stumbled across more detailed documentation only via the search bar.

Also the autogenerated heading navigation section is not visible on mobile, and is not generated at all for https://psalm.dev/docs/annotating_code/type_syntax/atomic_types/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:internal The PR will be included in 'Internal changes' section of the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants