Split up 'advanced usage' page #522
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
;)