reference icon indicating copy to clipboard operation
reference copied to clipboard

Idea: Add a "General" section for each of the chapters that has both top-level contents and sections.

Open crlf0710 opened this issue 2 years ago • 2 comments

Currently some chapters having sub-sections are totally blank in the top-level, while some chapters has contents within the chapter-link. Personally i think this is both inconsistent and ugly. I'd suggest we move to a model closer to ISO standards and many other specifications - Move the top-level contents to a first subsection consistently called "General". (Not sure whether this is well-supported by mdbook or not).

crlf0710 avatar Nov 19 '21 18:11 crlf0710

Also cc #205

crlf0710 avatar Nov 19 '21 18:11 crlf0710

Yea, the blank pages need to be filled out. Can you say specifically which ones you are looking at? I think the vast majority have content that introduces the concepts of the chapter. The empty ones that I see are:

  • Lexical Structure: The whole chapter needs to be rewritten (#567).
  • Type System: An introduction to Rust's type system would go here.
  • Memory Model: Not sure how this should evolve. The content of all its subsections is rather weak, and could all fit on one page. However, there could be room for expansion?
  • Appendices: I guess this could contain a one or two sentence description of what appendices are (contrast with why the content doesn't exist elsewhere).

ehuss avatar Nov 19 '21 18:11 ehuss