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

Break docs pages/ folder into subfolders and add forwarder aliases #3629

Merged
merged 5 commits into from
Sep 30, 2024

Conversation

lihaoyi
Copy link
Member

@lihaoyi lihaoyi commented Sep 30, 2024

The module hierarchy now matches the example/ folder hierarchy, which should make things easier to navigate. Shortened the individual .adoc file names to use a shorter convention to remove duplication with the folder name

It seems that the :page-aliases: declaration needs to happen on the line immediately after the title, and no later. Otherwise it silently doesn't work, which was causing a lot of forwarder pages to be missing before. Now they seem to appear properly

@lihaoyi lihaoyi marked this pull request as ready for review September 30, 2024 11:55
@lihaoyi lihaoyi merged commit 612a289 into com-lihaoyi:main Sep 30, 2024
24 checks passed
@lefou lefou added this to the 0.12.0-RC3 milestone Sep 30, 2024
lihaoyi added a commit that referenced this pull request Sep 30, 2024
Was meant to be in #3629, but
somehow I messed up my git-fu and it didn't get included

This removes a bunch of duplication from the folder/file names, reduces
the length of the URL significantly, and more closely matches most
common URL naming conventions. Lastly, by removing the literal
correspondence between the page title and the URL, it gives us a bit
more freedom to modify page titles without the disruption of having to
change the URL every time

Since we already had to add a bunch of forwarder aliases due to moving
the `.adoc` files into subfolders, we get the forwarding to the new URLs
for free
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

Successfully merging this pull request may close these issues.

2 participants