docs: credit Synapse Research Ltd in the page footer - #8
Merged
Merged
Conversation
A CREDIT constant in build_reference.py goes into both footer templates. The reference and the nine topic pages now name who built the API, with a link to the case study on synapsereality.io. The regenerated pages are committed, so --check stays green.
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.
Adds a "Built by Synapse Research Ltd" line to the docs footer. It links https://synapsereality.io/work/live-tennis-api/.
The line comes from a
CREDITconstant inscripts/build_reference.py, used by the two footer templates there. So it shows onreference.htmland the nine topic pages.index.htmlis the hand-written Scalar page andchangelog.htmlhas no footer, so neither changes.Checked locally:
python scripts/build_reference.pythen--check("generated docs are current"), andsh scripts/truthcheck.sh(OK). Each regenerated page differs by that one line only.Merging publishes it through the Pages workflow.