Skip to content

fix(release): inline footnote — HF card renderer doesn't support footnotes#95

Merged
shaypal5 merged 1 commit into
mainfrom
fix/readme-inline-footnote
May 29, 2026
Merged

fix(release): inline footnote — HF card renderer doesn't support footnotes#95
shaypal5 merged 1 commit into
mainfrom
fix/readme-inline-footnote

Conversation

@shaypal5

Copy link
Copy Markdown
Contributor

HuggingFace's dataset card renderer uses standard CommonMark, which doesn't support [^footnote] syntax. The marker and definition were rendering as raw text. Converted to an inline parenthetical.

🤖 Generated with Claude Code

…otnotes]

Convert the [^macro] footnote to an inline parenthetical so the
macroeconomic context renders correctly on HuggingFace.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 29, 2026 09:41
@shaypal5 shaypal5 added type: bugfix Fixes a bug type: docs Documentation or narrative changes labels May 29, 2026
@shaypal5 shaypal5 merged commit 6f63d5d into main May 29, 2026
8 of 10 checks passed
@shaypal5 shaypal5 deleted the fix/readme-inline-footnote branch May 29, 2026 09:41
@github-actions

Copy link
Copy Markdown

pr-agent-context report:

No unresolved review comments, failing checks, or actionable patch coverage gaps were found on PR #95 in repository https://github.com/leadforge-dev/leadforge. Treat this PR as all clear unless new signals appear.

Run metadata:

Tool ref: v4
Tool version: 4.0.21
Trigger: pull request opened
Workflow run: 26630076326 attempt 1
Comment timestamp: 2026-05-29T09:41:26.865448+00:00
PR head commit: 9809cc71cbbbf1165b3321f7d0bd30c46a2e21d7

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates the release dataset README(s) to avoid Markdown footnote syntax ([^...]) because Hugging Face’s dataset card renderer uses CommonMark and renders footnotes as raw text.

Changes:

  • Replaces the [^macro] footnote marker + definition with an inline parenthetical note in release/README.md.
  • Applies the same footnote-to-inline conversion in release/huggingface/README.md (HF dataset card).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
release/README.md Removes CommonMark-incompatible footnote syntax by inlining the macro note.
release/huggingface/README.md Mirrors the same inline-footnote change for the Hugging Face dataset card README.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread release/README.md
Comment on lines 14 to +16
Mid-market SaaS vendors entered 2024–2026 with growth slowing and
customer-acquisition costs rising[^macro], so predicting *which* leads
convert within a fixed window has moved from a marketing nicety to a
survival skill. This dataset teaches that skill on a relational
substrate, with the realistic confusions (snapshot-window discipline,
leakage traps, channel signal weaker than vendor blogs imply) that
students will hit when they finally get hands on real CRM data.

[^macro]: Macroeconomic framing summarised in
[`docs/external_review/summaries/gemini_v2_summary.md`](../docs/external_review/summaries/gemini_v2_summary.md)
(median public-SaaS growth 30%→25% from 2023 to 2025; New CAC Ratio
rose materially in 2024).
customer-acquisition costs rising (median public-SaaS growth 30%→25%
from 2023 to 2025; New CAC Ratio rose materially in 2024), so
Comment on lines 59 to +61
Mid-market SaaS vendors entered 2024–2026 with growth slowing and
customer-acquisition costs rising[^macro], so predicting *which* leads
convert within a fixed window has moved from a marketing nicety to a
survival skill. This dataset teaches that skill on a relational
substrate, with the realistic confusions (snapshot-window discipline,
leakage traps, channel signal weaker than vendor blogs imply) that
students will hit when they finally get hands on real CRM data.

[^macro]: Macroeconomic framing summarised in
[`docs/external_review/summaries/gemini_v2_summary.md`](https://github.com/leadforge-dev/leadforge/blob/main/docs/external_review/summaries/gemini_v2_summary.md)
(median public-SaaS growth 30%→25% from 2023 to 2025; New CAC Ratio
rose materially in 2024).
customer-acquisition costs rising (median public-SaaS growth 30%→25%
from 2023 to 2025; New CAC Ratio rose materially in 2024), so
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: bugfix Fixes a bug type: docs Documentation or narrative changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants