You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Put one paragraph per line in 77 long articles - #184
The converter wrote whole articles onto one source line, with newlines encoded as . This puts one paragraph or list item per line in the 77 articles that had a line over 2,000 characters, so they can be edited in GitHub's browser editor and later wording reviews get readable diffs.
Formatting only. Each existing inside an article body becomes a real line break. Wording, markup and all other whitespace stay as they are. Every decoded break is recorded in migration/source-formatting.json like the 95 existing records, so the change is reversible: the fidelity check rebuilds each original file byte for byte from those offsets before checking anything else. As in the earlier records, entities that would start a blank line stay encoded (47, in 4 articles). Existing records are unchanged.
Built site unchanged. I built main and this branch and compared dist/:
1,455 of 1,532 files are byte-identical, including the whole Pagefind search index.
The 77 article pages differ only where the page source now has a literal newline instead of (3,965 places, exactly the recorded count for each page). Astro copies the article HTML as written, so these bytes can't stay identical, but each page parses to the same HTML document tree as on main.
running-bisq-in-china-sstap: an additional historical article, and formatting records on main cover only the 209 restored articles.
revolut: one inside a table cell shows up as the literal text in the page's hidden table search summary. Decoding it would change that text and the search index.
last-resort-restore: scripts/fixtures/restored/last-resort-restore.md pins its unformatted file for the tests, so formatting it needs a fixture update.
dao-technical-overview and domestic-wire-transfer still have one line just over 2,000 characters: the generated "On this page" navigation, outside the article body.
Re-run the checks
npm test
npm run build # the strict fidelity gate rebuilds every original file
To compare pages, build main and this branch into separate folders and run diff -rq. For a changed page, both versions are identical once every is turned into a newline, for example with perl -pe 's/ /\n/g'.
Decode the converter's existing &bisq-network#10; newline entities into real line
breaks inside the article bodies of 77 restored articles whose source
had a line over 2,000 characters, so they can be edited in GitHub's
browser editor and reviewed line by line. Wording is unchanged.
Record every decoded break in migration/source-formatting.json, like
the existing records; the fidelity check rebuilds each original file
byte for byte from these offsets. Entities that would start a blank
line stay encoded, as before.
Leave out articles touched by open pull requests, the additional
article running-bisq-in-china-sstap, revolut (its hidden table search
text would change) and last-resort-restore (a test fixture pins its
unformatted file).
Many wiki articles are now easier to scan in their source formatting; their existing guidance and details remain unchanged.
The Bisq 1 wiki page presents recovered content in sequential sections and lists, with the original legacy layout available in an expandable section. Unresolved templates and unrecovered links remain marked.
The pull request reformats HTML in many wiki articles from encoded newline separators into multiline source. It also reorganizes the Bisq 1 page into sections and removes a literal template wrapper from a DAO note.
Changes: Wiki documentation
Layer / File(s)
Summary
Recovered page content and template handling src/content/docs/wiki/bisq-1.md, src/content/docs/wiki/introduction-to-the-dao.md
The Bisq 1 page presents recovered resources in separate sections and keeps the legacy layout source in expandable details. The DAO revenue note is plain paragraph content rather than literal template syntax.
Wiki article multiline markup src/content/docs/wiki/*.md
Many articles replace encoded newline separators with source line breaks. Their article content and markup remain unchanged.
bisq-network/documentation#183: It updates fidelity checks that evaluate formatting records and files changed by this pull request.
Pre-merge checks: 4
Check name
Status
Explanation
Title check
The title clearly and concisely describes the main change: placing one paragraph per line in 77 long articles.
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Description check
The description clearly explains the formatting-only change, affected article set, exclusions, reversibility, build comparison, and requested checks. It does not explicitly provide the source revision…
Full details: Description check
Explanation
The description clearly explains the formatting-only change, affected article set, exclusions, reversibility, build comparison, and requested checks. It does not explicitly provide the source revision, article titles or links, or related note and issue IDs required by the template.
Warning
Review coverage is incomplete: 1 file could not be fully reviewed. Findings from completed review steps are included; see review info for details.
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Files not fully reviewed because they exceed a per-file size limit: 1
migration/source-formatting.json
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
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
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.
The converter wrote whole articles onto one source line, with newlines encoded as
. This puts one paragraph or list item per line in the 77 articles that had a line over 2,000 characters, so they can be edited in GitHub's browser editor and later wording reviews get readable diffs.Formatting only. Each existing
inside an article body becomes a real line break. Wording, markup and all other whitespace stay as they are. Every decoded break is recorded inmigration/source-formatting.jsonlike the 95 existing records, so the change is reversible: the fidelity check rebuilds each original file byte for byte from those offsets before checking anything else. As in the earlier records, entities that would start a blank line stay encoded (47, in 4 articles). Existing records are unchanged.Built site unchanged. I built
mainand this branch and compareddist/: (3,965 places, exactly the recorded count for each page). Astro copies the article HTML as written, so these bytes can't stay identical, but each page parses to the same HTML document tree as onmain.Left out
backing-up-your-wallet-seed(Add the BSQ SegWit derivation path #99),emergency-multisig-payout-tool(Keep emergency payout keys local #97),frequently-asked-questions(Distinguish external funding from avoiding the wallet #115).running-bisq-in-china-sstap: an additional historical article, and formatting records onmaincover only the 209 restored articles.revolut: one inside a table cell shows up as the literal text in the page's hidden table search summary. Decoding it would change that text and the search index.last-resort-restore:scripts/fixtures/restored/last-resort-restore.mdpins its unformatted file for the tests, so formatting it needs a fixture update.dao-technical-overviewanddomestic-wire-transferstill have one line just over 2,000 characters: the generated "On this page" navigation, outside the article body.Re-run the checks
To compare pages, build
mainand this branch into separate folders and rundiff -rq. For a changed page, both versions are identical once every is turned into a newline, for example withperl -pe 's/ /\n/g'.