Skip to content
clinssen edited this page Nov 14, 2019 · 23 revisions

Topics

  • documentation infrastructure for NEST, NESTML, NEST-Desktop, …

    • issue #1317 - missing documentation module > redirect people to NESTML in docs for module creation?
    • N.B. NESTML is migrating all documentation to readthedocs; theme will be consistent with NEST-simulator. Work-in-progress PR: https://github.com/nest/nestml/pull/517
    • visibility of NESTML / NESTDesktop on NEST
    • ...
  • automatic generation of images from pynest/examples

    • how to automatically build images and link them to generated examples
    • PR #1336 autogenerate examples
      • organize examples/provide description
  • NEST3 related documentation updates

    • name changes
    • remove nest3 incompatible documentation (including updating links)
    • include nestio into guide for nest 3 conversion
    • improve text, and general review of nest 3 docs
    • ensure both html and pdf build are working
  • integrating documentation into release workflow

    • discussion - what all needs to be checked in the documentation before release
    • running scripts (convert markup to proper links, check links ...)
  • PR #1274 pynest mock

  • PR #1262 install NEST instructions

    • FAQ / troubleshooting, discussion
  • PR #1139 pynest templates

  • nest models

    • remove SLI examples
    • reorganize/categorize models
    • add toc
  • styleguide review, discussion

  • contribution guidelines discussion

  • include linting (vale - github action, discussion)

  • analytics - matomo implementation

  • documentation web page layout

    • more visually appealing main page (showcase model types, certain topics, etc)
    • consider EPPO (every page is page one) in structure
    • better integration of nest-simulator website and docs
  • reviewing/ editing docs workflow improvement ideas

Clone this wiki locally