Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Of these different approaches, we currently employ all of these, and can suggest resources as the user advances in proficiency.

Two examples of this are the Python Documentation page and the Python Comprehensive Help page.

Another example is the documentation for the Django Project. It shows "The basics" and "Advanced" links for each thematic area.

Introduction Pages

Each manual and manual—and the Documentation itself has itself—has an "Introduction" page at the start.

Currently: These pages are a list of links with descriptions and important terms or phrases marked in bold:

...

Proposal: Have a tabbed panel that shows for different users user streams appropriate content (note: the content would not be a literal, ; that is a limitation of the current custom Sphinx extension used to illustrate this):

  • These tabbed panels could be used at the start of each Introduction.
  • As with our existing tabbed-parsed-literals, they would be synchronized, so that all would show the same tab, but with different content, in each area.
  • For each panel or "user stream" we could suggest a series of "The basics" and "Advanced" links.
  • One panel could be a complete index, similar to what we have currently.