This looks really great! I just started looking into horizon and this solved a lot of headache.

from horizon-docs.

It could make sense to add a "Basic Interface" Section before the Schematic Editor, where common actions (Grids, Interactive manipulator, selection, etc could be explained), what do you think?

from horizon-docs.

Okay I tried to create a more or less complete outline of what the whole structure could potentially look like (feel free to expand):

About

• Introduction and Quick Links
• Feature Overview
• Why horizon EDA?
• TOC

Getting Started

• Installation
  • Linux
  • Windows
• Setting up a pool
• Creating a new project
• Drawing a Schematic
  Show how to draw a simple schematic, while highlighting some interface features like spacebar menu and the interactive manipulator, etc
• Creating a board
  Create a simple board and export it

Basic Interface Usage

• Spacebar Menu
• Drawing
• Selection
• Moving (Interactive Manipulator)

Schematic Editor

• Basic Concepts
• Drawing
• Sheets
• Schematic Properties
• Annotation
• Buses
• Net Classes
• Power Nets
• PDF Export
• BOM Export

Board Editor

• Basic Concepts
• Rules
• Layers
• Placing Parts
  (Includes the whole back and forth between schematic editor)
• Route Tracks
  (Includes differential pairs, vias, locking, moving, length tuning, backannotation, ...)
• Planes
• Grouping and Tagging
• Fabrication Output
• DXF Import
• 3D Preview and Step Export

Pool Manager

• Why a Pool
  • Units
  • Symbols
  • Entities
  • Packages
  • Padstacks
  • Parts
• Tutorial: How to create a package
• Tutorial: How to create a part
• Inherit from other parts
• Contributing to horizon's pool
• On pool organization
• Project Pool Caches

Advanced Topics

• CLI usage
• Color Schemes
• Building from Source
• Maintaining pools with git
• Generating Parts by scripts

from horizon-docs.

LGTM, I rolled out your TOC suggestions in the wip branch. Rendered docs are at https://horizon-eda.readthedocs.io/en/wip/index.html

from horizon-docs.

Okay, that was fast, I will check if I can start on it later this evening.

from horizon-docs.

I remade the pool diagram you did over at horizon/docs to give it a little more clarity. I tried to mostly orient myself on your thing, but decided to leave a few things out (I planed to make a seperate thing that shows e.g. a single NAND entity using the same Unit etc.).

Does this look alright to you?

from horizon-docs.

Does this look alright to you?

Awesome, looks much more clear than my drawing.

The Symbol box inside the "Single Power" unit box should be outside of the pin box as in the "single ended nand" unit box. Technically, the top/bottom copper layers in padstacks, aren't drawn as polygons, but shapes instead. Not sure if that's to detailed for an overview drawing.

from horizon-docs.

Updated : )

from horizon-docs.

@niclashoyer The thing that is not pictured here tho is, that other entities (e.g. a imaginary "Dual NAND") could use the same "Single Ended NAND" Unit. That way if we change something in the Unit or the Symbol, it changes for all parts using NAND Units at once.

Ah and in case you overlooked it here is the work-in-progress documentation which I am working on at the moment

from horizon-docs.