Skip to content

chore: footer social handles + splice-sdk-nav lint nits - #114

Merged
WomB0ComB0 merged 1 commit into
mainfrom
chore/socials-and-splice-lint
Jul 28, 2026
Merged

chore: footer social handles + splice-sdk-nav lint nits#114
WomB0ComB0 merged 1 commit into
mainfrom
chore/socials-and-splice-lint

Conversation

@WomB0ComB0

@WomB0ComB0 WomB0ComB0 commented Jul 28, 2026

Copy link
Copy Markdown
Member

Small riders from the fix/api-docs-partial-failure-guard branch, landed onto current main.

  • docs.json footer socials: xresqsystems_inc, linkedinresq-systems-inc.
  • splice-sdk-nav.py: ruff nits only — unused loop vars → _, ambiguous lk, explicit encoding=\"utf-8\" on read_text/write_text. No behavior change; ruff check clean, compiles.

One thing to decide

The twitter:site / twitter:creator metatags in docs.json still read @ResQSoftware — your footer change didn't touch them, so I left them. If the X handle is now resqsystems_inc, those two metatags are stale too. Want me to update them in a follow-up, or are they intentionally different?

Summary by CodeRabbit

  • New Features

    • Updated footer social links, including X, GitHub, and LinkedIn destinations.
  • Documentation

    • Refined SDK navigation generation to ensure generated package references display the correct page links.
    • Improved consistent UTF-8 handling when updating documentation configuration.

- docs.json footer: x and linkedin handles -> resqsystems_inc /
  resq-systems-inc (the twitter:site/creator metatags still read
  @ResQSoftware; left for a follow-up decision).
- splice-sdk-nav.py: ruff nits only — unused loop vars renamed to _,
  ambiguous 'l' -> 'k', explicit encoding='utf-8' on read/write_text.
  No behavior change.

From uncommitted work on fix/api-docs-partial-failure-guard.
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@github-actions github-actions Bot added area:content MDX/MD documentation content area:meta Repo meta — docs.json, README, etc. labels Jul 28, 2026
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ff5aa39b-3a5a-446e-bb77-3cb560c1beaa

📥 Commits

Reviewing files that changed from the base of the PR and between 8fc6a73 and 5eba49d.

📒 Files selected for processing (2)
  • docs.json
  • scripts/splice-sdk-nav.py

📝 Walkthrough

Walkthrough

Updated footer social URLs and refined the SDK navigation splicing script to emit page IDs and use explicit UTF-8 encoding when processing docs.json.

Changes

Social link updates

Layer / File(s) Summary
Update footer social links
docs.json
Footer X, GitHub, and LinkedIn destinations were replaced.

SDK navigation generation

Layer / File(s) Summary
Update SDK navigation splicing
scripts/splice-sdk-nav.py
SDK navigation generation now appends sorted page IDs, ignores an unused language variable, and reads and writes docs.json using explicit UTF-8 encoding.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • resq-software/docs#95: Both changes update SDK-related navigation structures in docs.json or the script that generates them.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the two main changes: footer social handle updates and lint-oriented cleanup in splice-sdk-nav.py.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/socials-and-splice-lint

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.

❤️ Share

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

@WomB0ComB0
WomB0ComB0 merged commit 31b1c25 into main Jul 28, 2026
12 checks passed
@WomB0ComB0
WomB0ComB0 deleted the chore/socials-and-splice-lint branch July 28, 2026 03:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:content MDX/MD documentation content area:meta Repo meta — docs.json, README, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants