Skip to content
This repository has been archived by the owner on Nov 26, 2024. It is now read-only.

Extra "level" in TOC #92

Open
ReedCopsey opened this issue May 25, 2016 · 8 comments
Open

Extra "level" in TOC #92

ReedCopsey opened this issue May 25, 2016 · 8 comments

Comments

@ReedCopsey
Copy link
Contributor

The TOC current is structured as "Visual F#" / "Visual F# Development Portal" / "... all content ... "

Can we eliminate one (or both) of the two "top level" elements of the tree? Having to click through both adds no value.

image

@dend
Copy link
Contributor

dend commented May 25, 2016

Development portal has content in it, so does the Visual F# page. Don't think it's something that we can get rid off.

Would love to have @KevinRansom @dsyme to chime in on this.

@ReedCopsey
Copy link
Contributor Author

There's a lot of duplication in there - it seems like "Development Portal"
could easily be folded into "Visual F#" to make one page,and eliminate an
entire "level" of the tree.

On Wed, May 25, 2016 at 12:44 PM, Den Delimarsky [email protected]
wrote:

Development portal has content in it, so does the Visual F# page. Don't
think it's something that we can get rid off.

Would love to have @KevinRansom https://github.com/KevinRansom @dsyme
https://github.com/dsyme to chime in on this.


You are receiving this because you authored the thread.
Reply to this email directly or view it on GitHub
#92 (comment)

@cartermp
Copy link
Contributor

cartermp commented May 25, 2016

I believe both top-level nodes in the TOC provide value, but I do think that this child structure is a bit odd. I think it would be good to flatten the TOC:

Visual F#
Visual F# Development Portal
Visual F# Guided Tour/
    Introduction to Functional Programming in F#/
        Walkthrough: Your First F# Program
        Functions as First Class Values
Using Visual Studio to Write F# Programs/
...

Here is why I think that:

The "Visual F#" top-level TOC item feels like more of a "walkthrough of cool things about F#". This is useful information, especially if people want some quick motivation for why they might pick F#. I don't see that as being a parent of docs, though.

The Development Portal is a great central place that allows you to hop to various parts of the docs depending on the high level task. I don't see this as being a parent to docs, either. Although it's docs-related, it's really more of an organized set of groups that allow you to jump to various sections without having to hunt things down in the TOC.

@ReedCopsey
Copy link
Contributor Author

I wouldn't mind @cartermp 's option here - my main "gripe" is that it's adding an extra parent in the hierarchy to everything, which makes browsing odd - things get indented in the tree one extra time, which seems unnecessary.

Having it as the top page, but at the same level in hierarchy as "Guided Tour" makes sense.

@dend
Copy link
Contributor

dend commented May 26, 2016

I would be somewhat against merging them into one, but I would be OK with "flattening" the structure, similarly to what @cartermp suggested.

@ReedCopsey
Copy link
Contributor Author

Flattening would be good with me - I'm not sure how this would be done, however, given the files in the repo... I suspect it's something outside of the community content.

@cartermp
Copy link
Contributor

cartermp commented May 26, 2016

Looks like it can be done just by editing the TOC file. All doc files are in the same directory, so the relative links should still all work.

@dend
Copy link
Contributor

dend commented May 29, 2016

Structure-wise this is really a TOC change, as long as you don't touch the locations of the files.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants