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

Help home page should have a subtle link to list other tutorials #691

Closed
danstowell opened this issue Dec 15, 2012 · 0 comments
Closed

Help home page should have a subtle link to list other tutorials #691

danstowell opened this issue Dec 15, 2012 · 0 comments
Labels
comp: SCDoc scdoc syntax, parser, and renderer. for changes to schelp files, use "comp: help" enhancement
Milestone

Comments

@danstowell
Copy link
Member

On the Help home page, there's a link to "Getting started" tutorial, no other. I appreciate it's probably good for beginners to see a link to one-and-only-one tutorial so I'm not too upset by that.

But all the other tutorials are v hard to encounter. I can't actually find a way to get them listed, other than by finicky search queries.

I tried adding a link like this - it works although SCDoc doesn't render the text properly (a bug in the interaction between # and ## ?)

--- a/HelpSource/Help.schelp
+++ b/HelpSource/Help.schelp
@@ -17,7 +17,7 @@ SECTION::Getting started
These might be useful starting points on getting help with SuperCollider:

definitionlist::
-## link::Tutorials/Getting-Started/00-Getting-Started-With-SC##Getting Started tutorial series:: || Get started with SuperCollider
+## link::Tutorials/Getting-Started/00-Getting-Started-With-SC##Getting Started tutorial series:: || Get started with SuperCollider (link::Browse.html#Tutorials##List all tutorials::)

link::Guides/Glossary:: || Glossary

link::Guides/ClientVsServer:: || Explaining the client vs server architecture.

link::Guides/More-On-Getting-Help:: || How to find more help

Alternatively, maybe that "Indexes" dropdown at the top of the help browser could link directly to the Tutorials subsection.

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" enhancement
Projects
None yet
Development

No branches or pull requests

2 participants