Skip to content

V1 documentation #1529

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

Draft
wants to merge 15 commits into
base: v1.0
Choose a base branch
from
Draft

V1 documentation #1529

wants to merge 15 commits into from

Conversation

cpfiffer
Copy link
Contributor

@cpfiffer cpfiffer commented Apr 8, 2025

Draft PR to implement the general structure of the v1 documentation, following issue #1528.

@cpfiffer cpfiffer changed the base branch from main to v1.0 April 15, 2025 15:08
@rlouf
Copy link
Member

rlouf commented Apr 16, 2025

Are we switching to Hextra for it to look similar to the product doc? While I like the idea of having a similar design, mkdocs-material really makes a lot of things easy, such as automatically generating API reference documentation or integrating with Google Analytics. We could tweak the theme to have something similar looking, default to dark mode, etc. but I think we might be shooting ourselves in the foot by switching to Hextra.

@cpfiffer
Copy link
Contributor Author

It's a good point about mkdocs. Partly the goal was to have a visual refresh and to match the product documentation and present a cohesive brand image, as the Outlines docs are visually kind of messy IMO.

The advantage of sticking with mkdocs is that we have an established flow for generating the docs. It's also designed for Python and tends to work quite well.

As to Google Analytics, this is supported in Hugo easily. Automatic API reference is simple as well by adding a single step before the hugo site render, where we use something like lazydocs to generate markdown files from Python libraries.

@cpfiffer
Copy link
Contributor Author

I'm going to switch this back to mkdocs to limit the amount of work we'll have to do. I still want to make some visual changes though, but we may be able to do this in a series of PRs.

- More comprehensive introduction, features, installation instructions, and quick start examples.
- Removes older "get started" only, rather than taking users directly to copy-pastable code.
- Clarified installation instructions for `uv` and added a command for installing Outlines with the `transformers` backend.
- Improved the quick start section with a more detailed example, including comments for better understanding.
@cpfiffer
Copy link
Contributor Author

I reverted this back to the original mkdocs format, and am still updating the skeleton/moving things around.

@@ -15,3 +15,4 @@ benchmarks/results
build
docs/build
logs
.cursor/
Copy link
Member

Choose a reason for hiding this comment

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

Can you remove this and add it to .gitignore?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm confused here, it's in the gitignore and I don't think I've checked .cursor in.

@cpfiffer
Copy link
Contributor Author

cpfiffer commented Apr 29, 2025

Note: I'm changing the structure of the docs. Is it worth it to build all the redirects we'd need for the current sitemap?

EDIT: We should handle redirects. It'll be a bit of a pain but it's important to do, especially since there are many popular links to various parts of the documentation. We may need to address this in a separate PR.

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