Implement Table of Contents about docs HOT 6 CLOSED

Creating the TOC manually. I will also create a separate document in the repo to explain the way.

from docs.

Would that be possible to decide which documentation pages will have a TOC and which will not?

from docs.

Sadly I don't have an answer at the moment.

For the time being, I'd like to suggest using markdown headings on pages for which including ToC is necessary.

Here is an example:

• markdown file
• its raw content
• article on helpscout

It can be created it as follows. If there is a heading/title/subtitle (e.g. ### Example title or subtitle) you'll add - [Example title or subtitle](#example-title-or-subtitle) to the ToC. This will create link to title/subtitle in article.

Also, you can use different md elements to differentiate title from subtitle. For example,

- [Example title](#example-title) - for title
* [Example subtitle](#example-subtitle) - for subtitle

I've added these to the agent article as an example - feel free to change it :)
(doc on helpscout, markdown file in repository, raw )

from docs.

@mimimalizam In Semaphore 1.0, I've created a toc helper for markdown files https://github.com/renderedtext/semaphore-docs-new/blob/90c40594a3a72d9ef3237e6373b2ce12bc68578c/source/docs_helpers.rb.

With the helper, if you want a table of content on a particualar page, you can put:

<%= toc %>

anywhere on the page. Example: https://github.com/renderedtext/semaphore-docs-new/blob/43277f36408cd482f95a7e4a1713c803b6e7cd77/source/docs/cli-secrets.md.erb#L12.

Not sure if it can be used in this context. Let me know if it helps.

from docs.

tnx for pointing it out @shiroyasha 👏 🏆

After consulting @darkofabijan, we have decided to work on the programmatic implementation at some point next week (or during the week after).

In the meantime, please create the toc manually for pages where you find it necessary. (e.g. 3 articles) 🙇 @mactsouk

from docs.

I don't think we need this, writing ToCs manually wasn't so bad and can have useful effects as it makes you think about the structure of the page. Closing. :)

from docs.