Add links to subtopics to Spec page in manual #3510
Conversation
|
This is a move in the right direction but, as it is, the tree gives the false impression of being a ToC for the whole document. For example, it includes Install scriptlets but no Build scriptlets (because the latter is covered in the document itself). We should either make this into a real ToC, with links to the subdocuments as needed, or somehow denote that the links cover stuff not in the current document. I'm not sure how to accomplish either of that, though. Either way, I think we should also remove the tree from the index page then so that it's not duplicated in two places (that need to kept up to date separately). @pmatilai, any thoughts? |
|
The structure (or lack of thereof) and a ToC truly is a problem. And yeah I don't think adding duplicate links is a solution. The mess is the way it is because we didn't have a central place to put the various spec related items into. We have now, so I think the only right and sane thing is to move the links from the index page into the corresponding sections in the spec doc. And then, add an actual ToC within the spec doc. |
Make them fit in the overall structure.
ffesti
force-pushed
the
3359
branch
2 times, most recently
from
b583c80 to
6dfbf33
Compare
|
The Spec page needs more work - especially in the dependency area. But this is at least a step forward. Note that all the links are in the text down below, too. |
|
ToC probably could be auto-generated (much like in GitLab) but that would require additional setup in GitHub Pages and whatnot so let's just leave that for the future. The manual ToC doesn't necessarily mirror the exact structure of the document but it's good enough, for now at least. One little thing I've noticed is that a link to |
Include links to the sub topics there. Add links to Dependency sub topics to the Dependency section. Resolves: rpm-software-management#3359
Now everything is linked from the Spec Syntax page itself. No need to litter the may index page.
|
Thanks, since I had the branch checked out locally, I fixed up the markdown link (missing opening square bracket) and squashed the commit on top of the original one. |
Resolves: #3359