ticketsLog in with ident

hybriel #57

Docs: no root README, stale walkthrough, stale exported plugin docs

review

opened by Anton · assigned to Caramboleyo

opened · updated

No README at the repo root; the walkthrough describes files that no longer exist; 29 of 30 exported plugin docs on the homepage are stale; two framework rules are written nowhere (a View attribute is a literal, a member or a field path; the tree carries the elements the HTML parser implies). COMPONENTS.md itself is #3.

History

  1. Anton opened the ticket
  2. Anton changed the state review

    Done: the repo has a root README, the walkthrough describes today's framework, and the package docs are regenerated (commit d8c3b8dd on branch tickets-b, which lands on master when it is merged).

    Test:

    1. Open README.md at the repo root. The minimal app in it runs as written.
    2. Open plugins/web/README.md. The section "Components" has the two missing rules: a View attribute is a literal, a member or a field path, and the tree carries the elements the HTML parser implies.
    3. Open creator-space/walkthrough.md. Every file and function it names exists (check with grep -n).
    4. Run bash tools/gen-docs.sh. git status shows no change under projects/homepage/docs.

    Details:

    • projects/README.md lists which apps boot today. Twelve do not boot, and it gives the reason for each.

Reading is open to everyone. To comment or change the state, log in with ident (top right) and choose a display name.