bevy-website icon indicating copy to clipboard operation
bevy-website copied to clipboard

Flatten book layout

Open TrialDragon opened this issue 1 year ago • 6 comments

Makes the book use pages where before sections with just an _index.md file were for developer usability sake. Also does a minor change to the migration guides urls because apparently dots can't be in page urls turning it from 0.4-0.5 to 0-4-0-5. Now they're like 0-4-to-0-5 for readability sake.

Closes #160

TrialDragon avatar Jan 13 '24 10:01 TrialDragon

Still need to fix next / previous page navigation.

TrialDragon avatar Jan 13 '24 10:01 TrialDragon

I'd like to know opinions on the whole migration guide's url thing. Should those just be reverted to sections to avoid that issue at the cost of losing minor usability benefits moving to pages bring, or is it worth it to just keep them as pages and deal with the url change? (I already tried change the slug and such; pages unlike sections just can't have dots in the page url apparently.)

TrialDragon avatar Jan 14 '24 00:01 TrialDragon

(This comment is more of a note to myself to look into this) This PR may require fixing the migration guide stub generator since it may be generating the files as sections still (presuming migration guide stuff isn't switched back to sections.)

Edit: Mm, yep that's an issue. Will worry about / fix if migration guide as pages is kept.

TrialDragon avatar Jan 14 '24 23:01 TrialDragon

I'd like to know opinions on the whole migration guide's url thing. Should those just be reverted to sections to avoid that issue at the cost of losing minor usability benefits moving to pages bring, or is it worth it to just keep them as pages and deal with the url change? (I already tried change the slug and such; pages unlike sections just can't have dots in the page url apparently.)

I'd like to keep this consistent across the project and swap to pages. We should set up redirects though.

alice-i-cecile avatar Jan 22 '24 18:01 alice-i-cecile

I'd like to keep this consistent across the project and swap to pages. We should set up redirects though.

~~By redirects you mean setup dummy section pages that go to regular pages since the sections can have dots in url?~~

TrialDragon avatar Jan 22 '24 20:01 TrialDragon

Ope, ignore the previous comment; aliases just work for redirects with dots in them apparently? How did I not notice this when I was looking for solutions before... I'll commit that ASAP and get the conflicts solved.

TrialDragon avatar Jan 22 '24 21:01 TrialDragon

@BD103, could you take a look at this PR? I'd like to get this merged in before we start working on the book content further.

alice-i-cecile avatar Feb 14 '24 23:02 alice-i-cecile

@BD103, could you take a look at this PR? I'd like to get this merged in before we start working on the book content further.

Yeah, I'll give it my best shot! :D

BD103 avatar Feb 15 '24 01:02 BD103

Thanks a ton! This is much nicer to work with :)

alice-i-cecile avatar Feb 15 '24 22:02 alice-i-cecile