TuringLang / docs

Documentation and tutorials for the Turing language
https://turinglang.org/docs/
MIT License
231 stars 99 forks source link

Split up 'advanced usage' page #522

Closed penelopeysm closed 1 month ago

penelopeysm commented 2 months ago

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 ;)

github-actions[bot] commented 2 months ago

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

yebai commented 1 month ago

@torfjelde can you take a look?