stancl / tenancy-docs

stancl/tenancy docs & website
https://tenancyforlaravel.com/docs
MIT License
67 stars 636 forks source link

v4 notes #165

Open stancl opened 2 years ago

stancl commented 2 years ago

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

ianrobertsFF commented 2 years ago

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 commented 2 years ago

Yeah, v4 docs will be rewritten from scratch

abrardev99 commented 2 years ago

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 commented 2 years ago

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.