Skip to content

Docs: infer navigation hierarchy from filesystem #9151

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

Closed
wants to merge 2 commits into from

Conversation

ozkatz
Copy link
Collaborator

@ozkatz ozkatz commented Jun 6, 2025

Context: The docs are due for a restructuring - meaning moving around a lot of pages. to make it easier, this PR removes just-the-docs' need to specify a parent and grand_parent to every item and setting has_children on every parent.

It's not the prettiest code (thank you Liquid, and bigger thank you to GitHub Pages for not allowing custom Jekyll plugins).

Once the restructuring is complete, I'm OK with going back to the standard just-the-docs method if we don't want to maintain this.

@ozkatz ozkatz requested review from nopcoder and talSofer June 6, 2025 22:51
@ozkatz ozkatz self-assigned this Jun 6, 2025
@ozkatz ozkatz added docs Improvements or additions to documentation exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached labels Jun 6, 2025
Copy link

github-actions bot commented Jun 6, 2025

♻️ PR Preview 15cad63 has been successfully destroyed since this PR has been closed.

🤖 By surge-preview

@ozkatz
Copy link
Collaborator Author

ozkatz commented Jun 6, 2025

one regression this introduces that I'm not sure is worth fixing now (assuming we revert this at some point) is that breadcrumbs are gone :(

@nopcoder
Copy link
Contributor

nopcoder commented Jun 7, 2025

@ozkatz we no longer bound to github pages. you can use any plugin or version of site generator you like, we build the site and push it to the docs repository. we use github pages to render the static generated data.

@ozkatz
Copy link
Collaborator Author

ozkatz commented Jun 7, 2025

@nopcoder ahhhh nice! Does that mean I don't even have to use Jekyll? 🫣

@nopcoder
Copy link
Contributor

nopcoder commented Jun 7, 2025

@ozkatz yes, it should work. need to update the workflow with the tool you pick.
if you like to experiment, you can trigger the workflow on commit, just make sure you do not override the root. we usually publish to the /vXX.XX and /.

Copy link
Contributor

@nopcoder nopcoder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of the navigation items doesn't work - https://treeverse-lakefs-preview-pr-9151.surge.sh/experimental/

@ozkatz ozkatz closed this Jun 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation exclude-changelog PR description should not be included in next release changelog minor-change Used for PRs that don't require issue attached
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants