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

feat: port docs to mdBook #1360

Closed
wants to merge 5 commits into from
Closed

Conversation

MrPowers
Copy link
Collaborator

This PR ports the user guide to mdBooks.

This should make it easier to update the docs. Markdown files are more familiar than RST (restructured text).

mdBook also generates default URLs that are more SEO friendly.

mdBook also generates docs that are nicer looking ;)

We still need to figure out how to continue generating the API docs and properly link to them with mdBook. Let's collaborate on next steps!

@github-actions
Copy link

ACTION NEEDED

delta-rs follows the Conventional Commits specification for release automation.

The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification.

@MrPowers MrPowers changed the title Port docs to mdBook feat: Port docs to mdBook May 12, 2023
@MrPowers MrPowers changed the title feat: Port docs to mdBook feat: port docs to mdBook May 12, 2023
@wjones127
Copy link
Collaborator

I know this comment is a little late: but have we considered mkdocs instead of mdBook? It's still markdown, but it has an autodoc plugin, so it can also handle the API reference section. That way we can still have cross references in the User Guide, which I think is important. (It also occurred to me I was mixing these up in my head earlier since the names are so similar 🤦)

mkdocs is used by Ibis and Polars (also Pydantic and FastAPI). Ibis has user guide and API reference, while Polars just has a user guide in it. I could help setup the API reference part of that.

@rtyler
Copy link
Member

rtyler commented Jun 2, 2023

@MrPowers I think this would be something good for us to tidy up and land before Data and AI Summit. Personally I would like to have a unified book with different sections for Rust and Python rather than simply Python in our root docs/ directory. Are you open to me making that change?

I don't really see much reason not to land this work in progress and continue to iterate however

@MrPowers
Copy link
Collaborator Author

MrPowers commented Jun 6, 2023

@rtyler - yea, I'd love getting this out too.

I'm cool with @wjones127 suggestion to use mkdocs. I don't have the bandwidth to work on the mkdocs implementation, but would fully support someone else building it (and copying the markdown files in this PR if that'd be useful).

The only point that I am really passionate about is choosing a technology that properly structures URLs / HTML and organizing the content in a SEO friendly manner.

@MrPowers
Copy link
Collaborator Author

Closing in favor of a mkdocs PR: #1548

@rtyler
Copy link
Member

rtyler commented Sep 15, 2023

I believe this was supposed to be closed previously

@rtyler rtyler closed this Sep 15, 2023
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.

4 participants