Skip to content

Latest commit

 

History

History
64 lines (62 loc) · 2.85 KB

File metadata and controls

64 lines (62 loc) · 2.85 KB

Conversion tasks and initial editing

Get CI up and running

Fix that whole extra line breaks bug

Rewrite README

Link to SUMMARY.md

Document building mdbook

Move some of the existing prose to a preface chapter

Build docker container locally instead of using one from my personal forgejo

Add links from github to mdbook and from mdbook to github

This one’s best done after migrating to the community project so we can have the correct url

Organize ipkg modules in chapter order

Break Chapters into sub-chapters as appropriate

Configure mdformat

Audit links

Figure out exercise solutions situation

Will probably want to either convert the solutions files to markdown with katla or manually, and add them in a an appendex. Will need to go back and insert links/references.

Consistent on summary vs conclusion

Admonish

Get an admonishment extension up and running and edit to use it as appropiate

STRT Clean Up Prose

Need to:

  • Remove use of first person singular, to reflect the collective ownership
  • Update prose to reflect the new sub-chapter structure
  • Update links and clean up broken ones
  • Other minor editing changes to make the text flow better

Cleanup Imports and Exports

Clean up fixity declarations

Cleanup references to outdated sources

Like the wiki library page

Clean up exercise titling

Make sure section names match up with headers in solutions

Inject highlighted repl output

Actual test injection

Thread local IDEMode?

Golden Tests

Should golden test the repl outputs to detect breakage

These should also be compared in a whitespace insensitive way, im thinking, like:

```repl-session
> length ["lines that start with > are repl commands"]
1
> length ["subsequent lines before the next", "are the golden output"]
2
```

This keeps it readable as a raw markdown document, but provides easy processing for extraction and injection of the actual repl output complete with highlighting.

Special Handling for exec

Selenized custom themes

Because I love myself

IDEA Standard library types

When a subchapter reimplements a standard library type, we should maybe call this out and use the standard library type in future subchapters to decrease cross dependencies

IDEA Rename Modules To Chapter/Subchapter number?

Could also potentially insert automatic linking?

New sections

Property based testing

Place modules and visibility primer in the introduction

This needs to come early in the book so new programmers can make sense of the use of imports to reference statements from the previous chapter.

Totality Primer

Named argument syntax primer

Particularly in the context of record constructors

Mdbook features

linkcheck