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

Extra "level" in TOC #92

Open
Open

Description

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

Activity

  1. dend commented on May 25, 2016

    @dend
    Contributor

    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 Kevin Ransom (@KevinRansom) Don Syme (@dsyme) to chime in on this.

  2. ReedCopsey commented on May 25, 2016

    @ReedCopsey
    ContributorAuthor

    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 notifications@github.com
    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 Kevin Ransom (@KevinRansom) https://github.com/KevinRansom Don Syme (@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)

  3. cartermp commented on May 25, 2016

    @cartermp
    Contributor

    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.

  4. ReedCopsey commented on May 25, 2016

    @ReedCopsey
    ContributorAuthor

    I wouldn't mind Phillip Carter (@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.

  5. dend commented on May 26, 2016

    @dend
    Contributor

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

  6. ReedCopsey commented on May 26, 2016

    @ReedCopsey
    ContributorAuthor

    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.

  7. cartermp commented on May 26, 2016

    @cartermp
    Contributor

    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.

  8. dend commented on May 29, 2016

    @dend
    Contributor

    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 join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions