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

v4 notes #165

Open
stancl opened this issue Jun 4, 2022 · 4 comments
Open

v4 notes #165

stancl opened this issue Jun 4, 2022 · 4 comments

Comments

@stancl
Copy link
Owner

stancl commented Jun 4, 2022

Writing down notes to mention in v4 docs, so that we can clean up the issues here.

@stancl stancl pinned this issue Jun 4, 2022
@ianrobertsFF
Copy link
Contributor

Overhauling the docs in general would be a good idea, there's plenty of stuff in the v3 docs that are still missing/todo.

Understandable not updating those now given that v4 is coming, but ideally v4 shouldn't release with similar "see v3/v2 docs" or "TODO", etc.

@stancl
Copy link
Owner Author

stancl commented Jun 13, 2022

Yeah, v4 docs will be rewritten from scratch

@abrardev99
Copy link
Contributor

Can we make headings clickable in v4? It's actaully just wrapping them in a tag. I see almost all headings have the id attribute so that we can use id in href.
I think it makes sense to copy documentation links to a specific page and then a specific heading. Like in Laravel documentation, headings are clickable, and the URL appends with #some_heading.

Note It's a small change. We can ignore it, but it's good UX as almost all docs site has this, and it's kind of become muscle memory.

@stancl
Copy link
Owner Author

stancl commented Aug 7, 2022

Yeah, I'd add a clickable # in front of the headings. Like Laravel docs: https://laravel.com/docs/9.x/installation#laravel-and-docker

Usually the # is clickable and the heading isn't, but I see that in Laravel docs they are both clickable, and it's probably better UX.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants