denisrosset commented 6 years ago

I am collecting here issues/PRs related to documentation/tut/microsites.

Currently, we have upgraded your build to SBT 1.0, but microsites is not yet compatible with that release.

553 Subtyping graphs in documentation

607 @tixxit PR to introduce microsites

However, we started checking our documentation with tut ( #680 #692 ). We should consider:

[ ] updating the README.md automatically as part of a SBT task
[ ] splitting the documentation in easily digestible pieces (ala cats: typeclasses, data types, ...)
[ ] when microsites is ready (or if we can use another solution), introduce a website for Spire

We should document the motivation of default instances as well (for example, lattices for Int/Short/Byte...)

denisrosset commented 6 years ago

@non: microsites should actually be compatible with SBT 1.0. Algebra has migrated.

denisrosset commented 5 years ago

Main headings

Getting started / contribute / community / license (main page)
Examples -- Quick start tutorial
Number types -- Primitive integers -- Unsigned integers -- Big integers (BigInt, SafeLong, Natural) -- Floating point numbers -- FixedPoint -- Exact real numbers (Rational, Algebraic, Real) -- Complex[A] and Quaternion[A] -- Interval[A] -- Polynomial[A]
Algebraic structures / Type classes -- Syntax summary -- Semigroup/Monoid/Group -- Additive/Multiplicative S/M/G -- Eq/PartialOrder/Order/Signed/TruncatedDivision -- CRing, UFD, GCDRing, EuclideanRing, Field -- NRoot, Trig -- Noncommutative rings, DivisionRing -- Modules/VectorSpace/Algebra -- Actions
Algorithms -- Sorting -- Selection -- Searching
Randomness
Miscellany

denisrosset commented 5 years ago

See #760