Add an "Acknowledging or Citing SCALE" page - #18
Open
atsetilam wants to merge 5 commits into
Open
Conversation
Adds a citation page giving ready-to-copy BibTeX for the two SCALE
papers (HCDS '25 and Middleware '24, fields taken from Crossref) and for
the software itself, plus plain-text forms. Copy-to-clipboard comes free
from the theme's existing content.code.copy feature.
The page is a DRAFT: the proposed values are pending answers from the
team, and every open decision is marked with a TODO(cite-N) comment
matching the questions asked internally. It is therefore kept out of the
nav for now; re-enable the nav entry in mkdocs.yml once the TODOs are
resolved and the draft banner is removed.
Note for future editors: the macros plugin runs pages through Jinja2
before Markdown, so the {{...}} in BibTeX corporate-author fields must
stay wrapped in {% raw %} or the build breaks.
Use the tracked Discord short link and the .com contact address.
Keeps a single source of truth for the Discord URL.
atsetilam
force-pushed
the
docs/how-to-cite-scale
branch
from
July 15, 2026 10:48
0fc13c8 to
95553ff
Compare
Restructure along the lines of scikit-rf's "Acknowledging or Citing" page, with "In Presentations or Apps" first: we care more about people acknowledging that they use SCALE than about formal citations. - Academic citations now point at the latest paper (HCDS '25) only. - Drop the @software/@misc entries: the paper is the citation. - Offer suggested "powered by" wording and invite people to ask us for logo assets. - Remove the draft banner and the TODO markers; re-enable the nav entry and drop the page from not_in_nav.
atsetilam
changed the title
atsetilam
marked this pull request as ready for review
July 15, 2026 11:17
SCALE targets NVIDIA GPUs too, and portability is only one reason to use it, so the example should not presume AMD or a porting use case.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Adds an Acknowledging or Citing SCALE page, modelled on scikit-rf's equivalent page, and links it in the sidebar nav.
Notes for reviewers
macrosplugin runs pages through Jinja2 before Markdown, so the BibTeX block must stay wrapped in{% raw %}or the build breaks on the braces.--andS{\o}ndergaardis escaped for non-UTF-8 bibliographies.content.code.copy, so every snippet gets a button.Verification
mkdocs build --strict: clean.