docs(contributing): added section about how we handle page routing#4806
docs(contributing): added section about how we handle page routing#4806flippedcoder wants to merge 4 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📖 Docs PR preview linksThis PR does not change any pages in /docs. If you make updates, links to the modified pages will appear here. |
|
|
||
| If you are considering using a custom slug, answer these questions first: | ||
|
|
||
| - Does the page _need_ a custom URL? If so, why? |
There was a problem hiding this comment.
I think it would be more helpful for us to define what, if any, valid reasons there are to have slugs?
There was a problem hiding this comment.
I'm with you on this, but I haven't been able to figure out a good reason for the slugs, other than "convenience." And because it'll break a lot of links if we remove them.
There was a problem hiding this comment.
Yeah... I wasn't sure if we even want to recommend using slugs at all. I did make an update to this so let me know what y'all think. But honestly, I'm leaning towards removing it and just saying we don't recommend using slugs at all.
There was a problem hiding this comment.
I think the update is good for now. We should think through if our current slugs are needed in any case (or if we could just move things around) and if so, we can update the doc
4 participants
What does this PR do?
We were inconsistently using the
slugfield in the frontmatter and it causes unexpected issues with redirects. This aims to clarify when and why to use theslugfield.Notes to reviewers
┆Attachments: EDU-6635 docs(contributing): added section about how we handle page routing