Skip to content

[#317] Sort out documentation in the repo

Ivan Gromakovskii requested to merge gromak/#317-docs into master

Description

Problem: docs/ folder is messy. In particular, some part of it applies only to one package (many docs are specific to the morley package).

Scope of this MR:

  1. Move various documents from docs/ to deeper locations (belonging to individual packages).
  2. Remove obsolete stuff from some documents.
  3. Update some README files.

Related issue(s)

Resolves #317 (closed)

Checklist for your Merge Request

Related changes (conditional)

  • Tests (see short guidelines)

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
  • Documentation

    • I checked whether I should update the docs and did so if necessary:
    • I updated changelog files of all affected packages released to Hackage if my changes are externally visible.

Stylistic guide (mandatory)

Edited by Ivan Gromakovskii

Merge request reports