Skip to content

Add an index tree #827

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

Closed
bennuttall opened this issue Feb 19, 2018 · 3 comments
Closed

Add an index tree #827

bennuttall opened this issue Feb 19, 2018 · 3 comments
Assignees
Labels

Comments

@bennuttall
Copy link
Contributor

As suggested in #801, we should add an index tree containing the docs index.

From #801:

For the docs index tree, is it possible to genreat that automatically?

That's what I had in mind

Woudl it also be possible to have metadata per page to act as a brief content descriptor that could be used in the index?

Probably not. I think it'll be possible to use the h1 from each page rather than the directory name, but getting a meaningful description of the page would be tricky. I think the page title should be sufficient.

I could either do it in PHP, and it'll purely live on the web server (not on GitHub), but will be generated and updated automatically, or I could do it in Python (probably easier) and the output can live on GitHub too - but that'll need re-running to keep it updated as the index changes (not very often tbh). Manual re-run wouldn't be EOTW but post-commit script would require some setup. I'll have a think. First: glossary.

@bennuttall
Copy link
Contributor Author

@grega do you think your static site builder could add a site index made up of a tree of headings like my attempt here: https://github.com/raspberrypi/documentation/blob/827-index-tree/index.md

@grega
Copy link
Contributor

grega commented Apr 23, 2019

@bennuttall yep I reckon so! Will have a stab at it shortly...

@aallan
Copy link
Contributor

aallan commented Jun 7, 2021

Superseded by #1911

@aallan aallan closed this as completed Jun 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants