alan-if / alan-docs

Alan IF Documentation Project

Home Page:https://git.io/alan-docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

*** FINAL TASKS FOR BETA7 RELEASE ***

tajmone opened this issue Β· comments

This Issue will be constantly updated, pointing out the pending tasks that need to be attended.


Urgent Tasks

Issues or PRs that require immediate attention (as in: by yesterday πŸ˜‰).

  • #35 ("Manual on Verb Qualifiers") β€” @thoni56: there seem to be contradicting statements in Β§3.11, about VERB execution order (DOES [BEFORE|ONLY|AFTER]). VERBs. It might be worth fixing this "bug", for it affects understanding correctly how VERBs work.
  • #25 ("TBDs in App. G: Keep or Comment Out?") β€” @thoni56: it's just about deciding whether we should keep the "TO BE DONE" notices in those in-the-working chapters, or if temporarily comment out the whole section (title included), before the official release.
  • #41 ("Check Manual on Alan/ARun Switches") β€” @tajmone: just verify that the alan and arun switches mirror the current state of the Beta7 SDK release.

Valuable Tasks

Issues or PRs that only require minor efforts to be solved.

  • #8 ("Manual Info & Metadata") β€” @tajmone: worth adding the metadata before Beta7 release, shouldn't take long.
  • #63 ("Pending Glossary Entries") β€” not mandatory, but since there's only a single glossary entry right now, it might be worth adding a couple more, for completness sake.
  • #74 ("ALAN Manual 1st Release ETA") β€” @tajmone & @thoni56: discussing the final details to plan the release, like merge/squash strategy, pre-release checklist, and all other πŸ‘Ή nitty gritty gory details πŸ‘Ή.

That's It, Really...

The above pending Issues are the last ones in the "mandatory list" before the Beta7 release of the Manual. So, handled those we only need to do some cleanup (e.g. checking that the version info of both the Manual and the ALAN SDK are correct, etc.,), and decide how to publish (merge vs squash), and other nitty gritty β€” to be dealt with in #74.

The rest of the pending improvements are listed in the Alan Manual (dev) project, but none of them are preventing the first release of the book.