book: polish Internals appendix intro and two chapters - #213
Merged
Conversation
index.md's opening restated who the part was for twice (a vague "for a
different reader" sentence, then a specific "written for developers who
want to understand or build graph databases" paragraph) and included a
marketing metaphor ("small enough to hold in your head") that added
nothing factual. Merged the audience statement into one sentence, cut
the metaphor down to the plain fact list, and cut the closing "How to
read this part" section entirely — the fact it stated (paths are
repo-root-relative) is obvious enough not to need saying.
query-frontend.md and case-studies.md each had one real issue: a
mid-sentence dash interjection, and two spots restating a fact already
given a sentence or paragraph earlier. The other 8 Internals chapters
were already clean on review — no changes.
'graph' is a reserved keyword in Mermaid (the older diagram-type declaration, e.g. 'graph TD'), so using it as a node id broke the parser at mermaid 11.6.0 with "Syntax error in text" on the live site.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #212: reviewed the whole Internals appendix for the same style issues fixed in the main book rewrite. index.md had a redundant audience statement, a marketing metaphor, and an unnecessary closing section; query-frontend.md and case-studies.md each had one small dash-interjection/restatement issue. The other 8 chapters were already clean.