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

markdowns/SUMMARY.md is not consumed as expected. #187

Open
pburkholder opened this issue Jun 30, 2016 · 3 comments
Open

markdowns/SUMMARY.md is not consumed as expected. #187

pburkholder opened this issue Jun 30, 2016 · 3 comments

Comments

@pburkholder
Copy link
Contributor

The contents of SUMMARY.md should be included on the Table of Contents at the top level of the GitBook site (see https://toolchain.gitbook.com/structure.html and https://toolchain.gitbook.com/pages.html for the role of SUMMARY.md)

The navigation from SUMMARY.md is included in the leftNav (About the SSP, System Classification) but the contextual descriptions are not generated into book contents in either HTML or PDF form.

I think the images tell a better story, so here:

screen shot 2016-06-30 at 5 36 18 pm
screen shot 2016-06-30 at 5 36 32 pm

Expected resolution: SUMMARY. md contents are included on the GitBook contents page after the Introduction (from README.md) and before the contents generated from OpenControl YAML files.

@pburkholder
Copy link
Contributor Author

The code that generated the above screenshots is at: https://github.com/pburkholder/freedonia-compliance/tree/issue-187

@pburkholder
Copy link
Contributor Author

It looks like exports/SUMMARY.md should ONLY be table of contents and sections and `exports/README.md' should ONLY be the Introductory material, no contents.

Otherwise the navigation gets weird.

I can post an example.... (tomorrow).

@afeld afeld added the question label Jul 1, 2016
@afeld
Copy link
Member

afeld commented Jul 1, 2016

Care to send a pull request and add recommendations in the README?

@mogul mogul added the HighBar label Jul 8, 2016
@mogul mogul added the Icebox label Jan 24, 2017
@mogul mogul removed the Icebox label Feb 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants