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

Template funcs docs should live in subsections #141

Open
bep opened this issue Jun 14, 2017 · 9 comments
Open

Template funcs docs should live in subsections #141

bep opened this issue Jun 14, 2017 · 9 comments

Comments

@bep
Copy link

bep commented Jun 14, 2017

Matching the tpl/* namespaces where the implementation lives, see

https://godoc.org/github.com/gohugoio/hugo

@rdwatters
Copy link
Owner

cc/ @budparr for any theme/design considerations here...

@bep
Copy link
Author

bep commented Jun 14, 2017

To add to this: I don't think each func should be listed in the left menu (I think we have discussed that before, it is very long and hard to navigate currently, and it will get worse), a list of the subsections would be nice.

@digitalcraftsman
Copy link
Collaborator

With subsections you refer to the namespaces, right?

@rdwatters
Copy link
Owner

I think we have discussed that before

Yes, we did. Agreed that left nav list is too big to be expanded by default, but also showing only NSs assumes too much of end users; i.e., newbs can intuit more from a function's name than it's namespace. I'll defer to Bud's thoughts on presentation.

@rdwatters
Copy link
Owner

rdwatters commented Jun 14, 2017

As an FYI for this thread, ns is already a part of the new functions archetype:

https://github.com/rdwatters/hugo-docs-concept/blob/master/archetypes/functions.md

@rdwatters
Copy link
Owner

@budparr Would it be easier, at least navigation wise, for me to treat the ns as an attribute for each file in this section or put files individual directories? My thoughts are that it's still easiest for end users to see an alphabetical list of functions, but clumping them together (similar to current official docs) could have value. LMK how I can facilitate.

See also gohugoio/gohugoioTheme#38

@bep
Copy link
Author

bep commented Jun 20, 2017

To clarify what I mean by this:

  • Every single md-file for every template func should be put in a file folder corresponding to the Namespace they belong to (see Godoc).
  • Eeach "namespace section" should then have a content file with a reasonable title + description.
  • The section listings could sort sub sections alphabetically, but this will be a handful, so not very important.
  • This should not be an alphabetical list of all functions. There is a thing called search. Use that.

@rdwatters I suggest you start by just moving files into sub folders and "see how it looks".

@budparr
Copy link
Collaborator

budparr commented Jun 20, 2017

I agree that, if we're using subsections, it would be easier to navigate that rather than the full list. But I disagree about there being a full list somewhere. I don't find Algolia search all that useful and find myself accessing the drop-down list pretty much 100% of the time.

@budparr
Copy link
Collaborator

budparr commented Jun 21, 2017

@rdwatters when you've moved the files, share that branch with me, and I'll work on the design aspect.

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

No branches or pull requests

4 participants