diff --git a/README.md b/README.md index 728a42e..7afdf12 100644 --- a/README.md +++ b/README.md @@ -28,4 +28,14 @@ hugo server | `ci.yml` | the site builds and names every member organisation and repository; the notebook prints what the page says | | `links.yml` | every link and image of the built site resolves (`landingkit links`) | +## Documentation + +The documentation site is [go-scikit/docs](https://github.com/go-scikit/docs), +served at . The roadmap section of the page +lists the parity-plan organisations with their status (a package is "released" +only when a tag exists) and, where they exist, their landing and docs sites: +[go-approx](https://go-approx.github.io/), [go-dsp](https://go-dsp.github.io/), +[go-sparse](https://go-sparse.github.io/) and +[go-bignum](https://go-bignum.github.io/). + BSD-3-Clause. diff --git a/hugo.toml b/hugo.toml index b4649de..5de8033 100644 --- a/hugo.toml +++ b/hugo.toml @@ -124,7 +124,8 @@ disableKinds = ['taxonomy', 'term', 'rss', 'sitemap', '404'] # The roadmap section (#roadmap). Every statement is from # https://github.com/go-scikit/roadmap (PLAN.md and STATUS.md); the new -# organisations have no sites yet, so they link to their GitHub pages. +# organisations that have a landing and a documentation site carry `site` and +# `docs`; the others link to their GitHub pages. [[params.waves]] name = "Wave 1: the everyday MATLAB core" what = "Correctly rounded big.Float functions and a Go oracle harness; sparse matrices and iterative solvers; interpolation and splines; filter design and spectral estimation." @@ -144,20 +145,28 @@ disableKinds = ['taxonomy', 'term', 'rss', 'sitemap', '404'] [[params.neworgs]] name = "go-bignum" - state = "in progress" + state = "bigfloat in development, not yet tagged" what = "arbitrary precision, number theory, the Go oracle harness" + site = "https://go-bignum.github.io/" + docs = "https://go-bignum.github.io/docs/" [[params.neworgs]] name = "go-sparse" - state = "in progress" + state = "sparse v0.1.0 released" what = "sparse matrices, orderings, iterative and direct solvers, sparse eigensolvers" + site = "https://go-sparse.github.io/" + docs = "https://go-sparse.github.io/docs/" [[params.neworgs]] name = "go-approx" - state = "interp v0.1.0 released; poly performance work in review (poly#2)" + state = "interp and poly v0.1.0 released" what = "interpolation, splines, polynomials, Chebyshev and AAA approximation, scattered data" + site = "https://go-approx.github.io/" + docs = "https://go-approx.github.io/docs/" [[params.neworgs]] name = "go-dsp" - state = "in progress" + state = "signal v0.1.0 released" what = "filter design and filtering, spectral estimation, resampling, wavelets, audio I/O" + site = "https://go-dsp.github.io/" + docs = "https://go-dsp.github.io/docs/" [[params.neworgs]] name = "go-symbolic" state = "planned" @@ -207,6 +216,11 @@ disableKinds = ['taxonomy', 'term', 'rss', 'sitemap', '404'] kind = "assets" href = "https://github.com/go-scikit/brand" blurb = "Logos and icons in SVG / PNG / JPG / ICO / ICNS; the mark is the stack, written by a Go program from the list of member organisations." +[[params.repos]] + name = "docs" + kind = "docs" + href = "https://github.com/go-scikit/docs" + blurb = "The documentation site (Hugo and Hextra), served at go-scikit.github.io/docs: the member organisations with their landing and docs links, and the status of the parity-plan packages." [[params.repos]] name = "roadmap" kind = "plan" diff --git a/layouts/index.html b/layouts/index.html index 67507ec..8f3a0e9 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -101,16 +101,16 @@

{{ len .Site.Params.claims }} claims, each with its evidence.

Roadmap

Parity with MATLAB and Mathematica, in four waves.

-

The goal is feature parity with MATLAB (base and toolboxes) and Mathematica, in pure Go (CGO=0), each piece validated against the reference tools of its domain. The plan, the home of each domain and the order of the work are in the roadmap repository: PLAN.md, STATUS.md and the bibliography. One package of the new organisations has been released so far: go-approx/interp v0.1.0 (speed comparison in its docs/perf.md). The vector-update kernels Axpy, Xpby, AxpyDot and Scale shipped in go-simd/floats v0.4.0. Performance pull requests are in review for poly, signal and sparse.

+

The goal is feature parity with MATLAB (base and toolboxes) and Mathematica, in pure Go (CGO=0), each piece validated against the reference tools of its domain. The plan, the home of each domain and the order of the work are in the roadmap repository: PLAN.md, STATUS.md and the bibliography. Four packages of the new organisations have been released at v0.1.0: go-approx/interp (speed comparison in its docs/perf.md), go-approx/poly, go-dsp/signal and go-sparse/sparse; go-bignum/bigfloat is in development and not yet tagged. The vector-update kernels Axpy, Xpby, AxpyDot and Scale shipped in go-simd/floats v0.4.0.

{{ range .Site.Params.waves }}

{{ .name }}

{{ .what | safeHTML }}

Homes: {{ .homes }}

{{ end }}
-

The {{ len .Site.Params.neworgs }} new organisations have no sites yet; they are on GitHub.

+

The {{ len .Site.Params.neworgs }} new organisations. The first four have a landing page and documentation; the others are on GitHub only.

    {{ range .Site.Params.neworgs }} -
  • {{ .name }} ({{ .state }}): {{ .what }}
  • +
  • {{ .name }} ({{ .state }}): {{ .what }}{{ with .site }} · landing{{ end }}{{ with .docs }} · docs{{ end }}
  • {{ end }}