Introduction Why Docs About
Introduction User guide Getting started Manage your account Manage a course DY syntax Course and skills Exo formats Designing a deliberate course Concepts Advanced matching Best practices Edition experience Mass import Mass update Measuring progress Offline support Open exo format Ordering Rich diff of DY syntax inside forges PRs Rich intermediate feedback Shared logic Sync Website Fix exo format Contribute Developer guide Architecture DY parser Parsing system Security Technical documentation

Website

Brainstorming and documenting the features and development of delibay.org in its respective repos.

Features

  1. A landing page with the WHY
  2. A further read to go deeper in the WHY and the HOW
  3. Documentations
    1. User guide
    2. Concepts
    3. Contribute
    4. Developer guide
  4. Changelog API for all codebases and interactive page
  5. About page

Content management

The website mostly consists of a lot of Markdown articles written and managed in the project repos.

TODO

Documentations

goal TBD Structure: TBD

TODO: how to be able to have dynamic sections in the docs, generated by scripts (Bash, PHP or JS). TODO: should the output be versionned or not ? Stored in separated temporary files or directly inside. Possible to generate on the server or too risky or too complicated because of dependencies ? goal having always up to date sections that comes from somewhere else Use cases:

  1. document component interfaces and contracts
  2. document current versions of all repos
  3. copy paste some specific files like web.php and api.php or document routes with php artisan route:list

https://diataxis.fr/#

About page

goal TBD

Future things to implement

  1. Fast search capability across docs and other pages
  2. Changelog API
  3. Changelog page with all latest versions, filters to show beta/major/minor/patch releases notes, filter by repository, search keywords or version numbers
  4. Extract docs as a slashdocs repos to easily integrate in other websites ?

Landing page

  • Icones DP
  • Exemples d'applications