-
Notifications
You must be signed in to change notification settings - Fork 101
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
Conversation
There was a problem hiding this 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.
Preview the changes: https://turinglang.org/docs/pr-previews/522 |
@torfjelde can you take a look? |
There was a problem hiding this 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) :)
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:
Some implementation details of this PR which may warrant discussion:
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.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.
I chose new names for the folders that don't really obey the existing structure.
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 typels
;)