Skip to content

chore: remove workaround for HTML tags#6721

Merged
LesnyRumcajs merged 1 commit intomainfrom
remove-html-workaround
Mar 12, 2026
Merged

chore: remove workaround for HTML tags#6721
LesnyRumcajs merged 1 commit intomainfrom
remove-html-workaround

Conversation

@LesnyRumcajs
Copy link
Copy Markdown
Member

@LesnyRumcajs LesnyRumcajs commented Mar 11, 2026

Summary of changes

Changes introduced in this pull request:

Reference issue to close (if applicable)

Closes

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Outside contributions

  • I have read and agree to the CONTRIBUTING document.
  • I have read and agree to the AI Policy document. I understand that failure to comply with the guidelines will lead to rejection of the pull request.

Summary by CodeRabbit

  • Documentation

    • Updated documentation link labels for improved clarity.
    • Refined email formatting in project documentation.
  • Chores

    • Updated spellcheck dictionary with new entries and tokens.
    • Enhanced spellcheck pattern recognition for specialized tokens.
    • Streamlined markdown spellcheck script for improved efficiency.

@LesnyRumcajs LesnyRumcajs requested a review from a team as a code owner March 11, 2026 16:28
@LesnyRumcajs LesnyRumcajs requested review from hanabi1224 and sudo-shashank and removed request for a team March 11, 2026 16:28
@LesnyRumcajs LesnyRumcajs force-pushed the remove-html-workaround branch from 1c13f43 to c6d5d78 Compare March 11, 2026 16:28
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 11, 2026

Walkthrough

The PR updates spellcheck configuration and dictionary entries, refactors a linting script, and refreshes documentation link labels and email formatting across multiple files for consistency.

Changes

Cohort / File(s) Summary
Spellcheck Configuration
.config/forest.dic, .config/spellcheck.toml
Updated dictionary token count from 262 to 267; added tokens (autolink/S, backfilling, backtick/S, datacap, dev, Hypercerts); removed token (chainsafe). Added three regex patterns (^[A-Z]+XX$, ^[A-Z]+YY$, ^[A-Z]+ZZ$) for placeholder token recognition during spell-check tokenization.
Documentation Updates
CONTRIBUTING.md, README.md, docs/docs/users/filecoin_services.md, docs/docs/users/introduction.md
Standardized link labels to use descriptive text ("Forest Documentation", "Forest Explorer", "GitHub", "ChainSafe Status") instead of URLs. Updated email obfuscation format in README.md and introduction.md to inline code formatting.
Lint Script Refactoring
mise-tasks/lint/spellcheck-markdown.sh
Simplified spell-check workflow by removing temporary directory creation and per-file HTML-stripping logic; directly invokes cargo-spellcheck on discovered Markdown files.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • hanabi1224
  • sudo-shashank
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: removing a workaround for HTML tags from the spellcheck script, which is the primary change across the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch remove-html-workaround

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
mise-tasks/lint/spellcheck-markdown.sh (1)

6-12: Consider using an array to preserve filenames safely.

While the current codebase has no markdown files with whitespace or special characters that would break the script, the unquoted $FILES expansion on line 12 is fragile. Using a bash array with null-terminated find output would make the script more resilient to future changes.

🛠️ Suggested improvement
-FILES=$(find . -name "*.md" \
-  -not -path "*/node_modules/*" \
-  -not -path "*/target/*" \
-  -not -path "*/.git/*" \
-  -not -path "*/CHANGELOG.md")
+mapfile -d '' FILES < <(find . -name "*.md" \
+  -not -path "*/node_modules/*" \
+  -not -path "*/target/*" \
+  -not -path "*/.git/*" \
+  -not -path "*/CHANGELOG.md" \
+  -print0)
 
-cargo spellcheck check --code 1 $FILES \
+cargo spellcheck check --code 1 "${FILES[@]}" \
   || (echo "See .config/spellcheck.md for tips"; false)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@mise-tasks/lint/spellcheck-markdown.sh` around lines 6 - 12, The FILES
expansion is fragile because unquoted $FILES breaks on filenames with
spaces/special chars; change the find + variable usage to build a
null-terminated array (use find ... -print0 piped into readarray/mapfile -d ''
to populate FILES as an array) and then call cargo spellcheck with the array
quoted as "${FILES[@]}" so filenames are preserved; update the FILES assignment
(the find invocation) and the final cargo spellcheck call accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/docs/users/introduction.md`:
- Line 55: The support label contains a typo: change the phrase "Hand-on
Support" to "Hands-on Support" in the user-facing docs line that currently reads
`Partnerships or Hand-on Support: \`forest (at) chainsafe [dot] io\``; update
that exact string to `Partnerships or Hands-on Support: \`forest (at) chainsafe
[dot] io\`` so the document uses the correct "Hands-on Support" wording.

---

Nitpick comments:
In `@mise-tasks/lint/spellcheck-markdown.sh`:
- Around line 6-12: The FILES expansion is fragile because unquoted $FILES
breaks on filenames with spaces/special chars; change the find + variable usage
to build a null-terminated array (use find ... -print0 piped into
readarray/mapfile -d '' to populate FILES as an array) and then call cargo
spellcheck with the array quoted as "${FILES[@]}" so filenames are preserved;
update the FILES assignment (the find invocation) and the final cargo spellcheck
call accordingly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 8d1d3ff4-e172-4e7b-9d7a-485f16b33f04

📥 Commits

Reviewing files that changed from the base of the PR and between 35de58c and a9a42f5.

📒 Files selected for processing (7)
  • .config/forest.dic
  • .config/spellcheck.toml
  • CONTRIBUTING.md
  • README.md
  • docs/docs/users/filecoin_services.md
  • docs/docs/users/introduction.md
  • mise-tasks/lint/spellcheck-markdown.sh

Comment thread docs/docs/users/introduction.md
@LesnyRumcajs LesnyRumcajs added this pull request to the merge queue Mar 12, 2026
Merged via the queue into main with commit f6fb334 Mar 12, 2026
45 of 46 checks passed
@LesnyRumcajs LesnyRumcajs deleted the remove-html-workaround branch March 12, 2026 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants