Skip to content

Document suggestion #87

@MarqueIV

Description

@MarqueIV

Not sure if you'd agree with this change, so I wanted to ask before submitting a PR.

Currently in your documentation, you have one large config file, the further down the page, you describe its various configuration options. The issue is as you're reading the descriptions of how to configure it, you're nowhere near the actual configuration itself. Additionally, on more than one occasion, I have found myself confused by a disparity between the documentation and the config file, before realizing I was looking at the wrong section in the config file that had similar names.

My suggestion would be, for each feature/area you are describing (e.g. templating, switching, etc.) copy that specific config example right to that area. That way a user won't have to constantly scroll back and forth.

Another thing that would help is a sort of TOC area up top that links down to the individual sections. If you want to go to templating, click that entry and you're scrolled right down.

That would address the limitations of the single-page documentation needed for using GitHub.

Anyway, I wanted to ask if you thought that's a good idea before making the change and submitting a PR because it's not a simple thing and will require an effort to separate out, and if you don't agree, it would be an impractical use of time.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions