Simplify log design docs

[pellared]

What

Refer to actual code in the design docs.

After this change I believe that we would only need to update the design docs if we would:

• Make significant changes in the design (e.g. we will introduce a new type to represent ReadableLogRecord)
• Update (add/remove/update) rejected proposals

After this change there is no need to update the design doc if we e.g. add a method to the interface or add a new option.

Why

Address #5071 (comment)

1. Make the design doc easier to maintain (up-to-date) when we will be doing design changes.
2. The design doc can be reused when double-checking the specification compliance before going stable.
3. The design doc can be also helpful in making design changes (additions) after OTel Go Logs is stable.
4. The design docs helps in onboarding future contributors.
5. Our memory is fragile (at least mine) and searching for information in Git takes more time.

My personal experience with docs is that if you have them, they give the most benefits when they are living-documentation (updated during development). It applies to design (and architecture) docs as well. Having the docs clean makes it easy maintain them and have them up to date.

Alternative

If we prefer not maintaining these documents we should at least highlight that this is the initial design and that the document can be outdated. However, I believe that the cost of having the design docs to up to date after this change is worth the value it they could provide.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.3%. Comparing base (3a72c5e) to head (4cbbf15).

Additional details and impacted files

@@           Coverage Diff           @@
##            main   #5077     +/-   ##
=======================================
- Coverage   83.4%   83.3%   -0.1%     
=======================================
  Files        243     243             
  Lines      15956   15956             
=======================================
- Hits       13309   13307      -2     
- Misses      2359    2361      +2     
  Partials     288     288             

see 1 file with indirect coverage changes

[XSAM]

👍