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

SCDoc: make each category breadcrumb a separate link #2916

Merged
merged 3 commits into from
Jun 3, 2017
Merged

SCDoc: make each category breadcrumb a separate link #2916

merged 3 commits into from
Jun 3, 2017

Conversation

mossheim
Copy link
Contributor

@mossheim mossheim commented Jun 2, 2017

Fixes #692.

Before, Cat>Subcat>Subsubcat would be one link. Now, each part of that
path is a separate link, with Cat going to Cat, Subcat going to
Cat>Subcat, etc.

image

Should I also increment the version number is SCDoc? (https://github.com/supercollider/supercollider/blob/master/SCClassLibrary/SCDoc/SCDoc.sc#L363)

Before, Cat>Subcat>Subsubcat would be one link. Now, each part of that
path is a separate link, with Cat going to Cat, Subcat going to
Cat>Subcat, etc.
@mossheim mossheim added the comp: SCDoc scdoc syntax, parser, and renderer. for changes to schelp files, use "comp: help" label Jun 2, 2017
@patrickdupuis
Copy link
Contributor

Tested and it works here 👍

Visually, it can be a little confusing when a help file belongs to multiple categories (ex: ServerTiming.schelp). Would it be a good idea to have a little more spacial separation between them?

@mossheim
Copy link
Contributor Author

mossheim commented Jun 2, 2017

Here are a few more options. What do you think?


image


image


image

@nhthn
Copy link
Contributor

nhthn commented Jun 2, 2017

@brianlheim my vote goes to the pipes

@mossheim
Copy link
Contributor Author

mossheim commented Jun 2, 2017

I'm also a fan of the pipes. :) I think I should increment the help version number just to be safe, does anyone disagree?

@nhthn
Copy link
Contributor

nhthn commented Jun 2, 2017

sure thing. i had no idea it had a version number tbh

@mossheim
Copy link
Contributor Author

mossheim commented Jun 2, 2017

Great! Both things are done now. I think incrementing is a good move since without it, the docs won't get rerendered and you wouldn't see the change. Shoutout to @patrickdupuis for making me aware of that.

@nhthn nhthn added this to the 3.9 milestone Jun 2, 2017
@bagong bagong merged commit 372d364 into supercollider:master Jun 3, 2017
@mossheim mossheim deleted the issue/692 branch June 5, 2017 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp: SCDoc scdoc syntax, parser, and renderer. for changes to schelp files, use "comp: help"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants