search

roc-lang / book-of-examples

Software Design by Example in Roc
Other
23 stars 15 forks source link

Logging framework - chapter outline #56

Closed noelrivasc closed 3 weeks ago

noelrivasc commented 1 month ago

Description

This PR is a draft outline for the topic proposed in issue #13 : the logging framework.

Current state

The aim at this point is to present an outline that is enough to judge if the approach is adequate, and if the scope is sufficient for a chapter.

Under /iterations, the first two are drafted. The idea is for each of them to build on the previous one, improving the design while offering opportunities to demonstrate language features and use.

A note on the use of platforms

In #13, the latest suggestion is to write the logging framework using two platforms (CLI and web server) to compare and contrast, and show how the platform influences design.

The outline proposed only includes the CLI implementation. My reasoning is that the differences between the web server and cli platforms aren't big enough that we end up with very different designs. The cli implementation on its own brings good opportunities to highlight the relationship between Roc and the underlying platform, and different ways to handle that relationship.

gvwilson commented 4 weeks ago

I realize this is a work in progress, but may I merge it as-is so I have material when I start rearranging order?

noelrivasc commented 3 weeks ago

I realize this is a work in progress, but may I merge it as-is so I have material when I start rearranging order?

Yes, that's perfect.