Skip to content

Support and advertise .slp extension#244

Merged
panglesd merged 3 commits into
mainfrom
switch-to-lsp
Jun 4, 2026
Merged

Support and advertise .slp extension#244
panglesd merged 3 commits into
mainfrom
switch-to-lsp

Conversation

@panglesd
Copy link
Copy Markdown
Owner

@panglesd panglesd commented Jun 3, 2026

I need released editor support for these extension now before the next slipshow version!

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 3, 2026

Review Change Stack

Warning

Review limit reached

@panglesd, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 1 minute and 7 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 2512fa0e-1bae-4033-9ecf-4aedaa8bd169

📥 Commits

Reviewing files that changed from the base of the PR and between f27be72 and 419606e.

📒 Files selected for processing (10)
  • CHANGELOG.md
  • docs/editor-setup.rst
  • docs/record-tutorial.rst
  • docs/special-elements.rst
  • docs/split-in-multiple-files.rst
  • docs/themes.rst
  • docs/tutorial.rst
  • docs/visual-structure.rst
  • src/cli/main.ml
  • src/lspishow/lspishow.ml
📝 Walkthrough

Walkthrough

This pull request migrates documentation and CLI help text to consistently use .slp as the primary slipshow source file extension instead of .md. Tutorial instructions, command examples, and code snippets are updated across all documentation files, with filenames like sum.md becoming sum.slp. The CLI help text for the compile command also updates its input file documentation. Additionally, the file discovery module now enables recursive directory traversal when searching for .md and .slp files.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and clearly summarizes the main change across the changeset: updating documentation and code to support and advertise the .slp file extension instead of .md.
Description check ✅ Passed The description relates to the changeset by mentioning the need for editor support for the extension that is being advertised throughout the PR changes.
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.

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


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 and usage tips.

Copy link
Copy Markdown

@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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
docs/visual-structure.rst (1)

1317-1317: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix broken inline-code markup for style.css.

The inline literal is unbalanced ( ``style.css `), which can render incorrectly in generated docs.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/visual-structure.rst` at line 1317, The inline literal for style.css is
unbalanced in the sentence "Now, create ``style.css containing exactly what used
to be inside the ``<style>`` element:" — fix the RST markup so both inline code
spans are balanced; replace the broken token with proper double-backtick
literals for the filename and the tag (e.g., ``style.css`` and ``<style>``) so
the rendered docs show correct inline code for style.css and the <style>
element.
docs/tutorial.rst (1)

86-92: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Update remaining tutorial commands/text to .slp for consistency.

This section still tells users to run slipshow serve prime-numbers.md, edit prime-numbers.md, and describes .md as the shared source, which now conflicts with the updated .slp guidance above and the PR objective.

Also applies to: 108-109

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/tutorial.rst` around lines 86 - 92, Replace references to the old `.md`
source with `.slp` in this section: change the example command from "slipshow
serve prime-numbers.md" to "slipshow serve prime-numbers.slp", update mentions
of editing and sharing "prime-numbers.md" to "prime-numbers.slp", and clarify
that the produced output remains "prime-numbers.html" while the editable/shared
source file is "prime-numbers.slp" so the wording is consistent with the `.slp`
guidance elsewhere.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/record-tutorial.rst`:
- Line 210: Edit the sentence that currently reads "Now, include the drawing in
your presentation with by modifying ``sum.slp`` to:" and remove the extraneous
word "with" so it reads "Now, include the drawing in your presentation by
modifying ``sum.slp`` to:"; locate the string in docs/record-tutorial.rst
(search for "include the drawing in your presentation with by modifying" or the
reference to ``sum.slp``) and update the wording accordingly.

---

Outside diff comments:
In `@docs/tutorial.rst`:
- Around line 86-92: Replace references to the old `.md` source with `.slp` in
this section: change the example command from "slipshow serve prime-numbers.md"
to "slipshow serve prime-numbers.slp", update mentions of editing and sharing
"prime-numbers.md" to "prime-numbers.slp", and clarify that the produced output
remains "prime-numbers.html" while the editable/shared source file is
"prime-numbers.slp" so the wording is consistent with the `.slp` guidance
elsewhere.

In `@docs/visual-structure.rst`:
- Line 1317: The inline literal for style.css is unbalanced in the sentence
"Now, create ``style.css containing exactly what used to be inside the
``<style>`` element:" — fix the RST markup so both inline code spans are
balanced; replace the broken token with proper double-backtick literals for the
filename and the tag (e.g., ``style.css`` and ``<style>``) so the rendered docs
show correct inline code for style.css and the <style> element.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 40b6cde5-0ce2-4b81-98e3-3b9a73377d6d

📥 Commits

Reviewing files that changed from the base of the PR and between e0fd086 and f27be72.

📒 Files selected for processing (9)
  • docs/editor-setup.rst
  • docs/record-tutorial.rst
  • docs/special-elements.rst
  • docs/split-in-multiple-files.rst
  • docs/themes.rst
  • docs/tutorial.rst
  • docs/visual-structure.rst
  • src/cli/main.ml
  • src/lspishow/lspishow.ml

Comment thread docs/record-tutorial.rst Outdated
panglesd added a commit that referenced this pull request Jun 3, 2026
@panglesd panglesd merged commit c436f48 into main Jun 4, 2026
8 of 9 checks passed
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.

1 participant