[Doc]: Complete the honeycomb book

[imrn99]

Scope

user guide

Problem

missing

Description

PR #442 has restructured the user guide into a book. Many of the new sections are incomplete, and some existing are using content from the old user guide.

Pages to update:

• Combinatorial maps
  • Components
  • Cell representation
  • Embedding
  • Element insertion / deletion (delete?)
  • Sews
• Transactional Memory (create subsections?)
• Contributing
• Project structure
  • Library
• Examples (just proofread)

Pages to add:

• Resources
  • Rust, CMaps, STM, our papers
• Setup
• Tutorials
  • Basics
    • init, basic edits, I/O & render, element insertion, query/iterate on cells
  • Algorithm writing
    • edge cut example (element reservation vs direct usage), Laplace smoothing example (rollback on err), kernels crate, attribute system w/ example
  • Parallel meshing
    • parallel needs, edge cut example (issues w.r.t. concurrency), STM, tx routine sigs (+ explain solution to composability), corrected edge cut, what STM handles and what it does not
  • Optimization (for both dev & user)
    • STM changes priority, STM dynamic (tx length, conflict rate...), tx accesses cost, possible methodology
• (Project structure) Applications