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

Split up 'advanced usage' page #522

Merged
merged 3 commits into from
Sep 23, 2024
Merged

Split up 'advanced usage' page #522

merged 3 commits into from
Sep 23, 2024

Conversation

penelopeysm
Copy link
Member

@penelopeysm penelopeysm commented Sep 14, 2024

This PR splits up the Advanced Usage page, making each section a page on its own.

I'm proposing this for a couple of reasons:

  1. It's easier for people to find what they are looking for via the sidebar.
  2. Having one section for "miscellany" tends to lead to clutter. Right now it's not very long but it could in principle keep growing and we probably don't want that.

Some implementation details of this PR which may warrant discussion:

  1. I'm aware we shouldn't try to break existing links. Therefore, I've kept the docs-09-using-turing-advanced notebook (Quarto will still build it so the link will still work, see e.g. the PR preview docs), but excluded it from the Quarto ToC. The contents of that page have been replaced with links to the new pages.

  2. I wasn't entirely sure what to do with the Task Copying section. Right now I've left it out, because it doesn't seem to be a piece of info that would make a difference to an end user. If there's something about this that impacts the user, it'd be great if we could expand upon it with examples.

  3. I chose new names for the folders that don't really obey the existing structure.

    usage-custom-distribution/
    usage-generated-quantities/
    usage-modifying-logprob/
    dev-model-manual/
    

    whereas most of the docs are docs-XY-.... I think the numbers have kind of outgrown their usefulness, some of them have been shuffled around in the ToC and generally they aren't very future proof. The only benefit of sticking to the original naming structure is, imo, it looks prettier when you type ls ;)

Copy link
Member Author

@penelopeysm penelopeysm left a comment

Choose a reason for hiding this comment

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

Also some minor questions about the contents of the docs. More for my own benefit than anything else.

tutorials/usage-modifying-logprob/index.qmd Outdated Show resolved Hide resolved
Copy link
Contributor

Preview the changes: https://turinglang.org/docs/pr-previews/522
Please avoid using the search feature and navigation bar in PR previews!

@yebai yebai requested a review from torfjelde September 20, 2024 11:35
@yebai
Copy link
Member

yebai commented Sep 20, 2024

@torfjelde can you take a look?

Copy link
Member

@torfjelde torfjelde left a comment

Choose a reason for hiding this comment

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

All looks good to me @penelopeysm ; good stuff!

One thing on the generated quantities section: we now also have := which also provides an alterantive way of keeping track of non-tilde values. It might be worth adding a section on this (though in a separate PR) :)

@penelopeysm penelopeysm merged commit 364d361 into master Sep 23, 2024
3 checks passed
@penelopeysm penelopeysm deleted the py/split-advanced branch September 23, 2024 21:41
github-actions bot added a commit that referenced this pull request Sep 23, 2024
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.

3 participants