Skip to content

Fix documentation formatting#554

Merged
urish merged 153 commits intoTinyTapeout:mainfrom
krisjdev:main
Oct 7, 2025
Merged

Fix documentation formatting#554
urish merged 153 commits intoTinyTapeout:mainfrom
krisjdev:main

Conversation

@krisjdev
Copy link
Copy Markdown
Contributor

@krisjdev krisjdev commented Oct 7, 2025

This PR fixes documentation formatting as a part of the work done for the datasheet template.

Each commit is only done per-project, so they can be cherry-picked or dropped if needed. Each commit may update info.yaml, info.md or both.

Projects were edited to:

  • remove unused sections (such as when "External Hardware" explained to be none/not relevant)
  • remove default filler text in sections where the user had not deleted it but added their own content
  • fix typos
  • add images which were referred to by a URL previously
  • remove non-descriptive alt text, and add descriptive ones where possible
  • resize images so they fit better on the page
  • fix broken links (when parsed with pandoc, they must be encased in <> or use pretty text)
  • fix list formatting
  • fix heading formatting (some users use H1 when it should be set to H2)
    • H1, when transformed by pandoc, turns into regular text
  • remove H1 text if it matched the title of the project
  • fix table formatting
  • fix syntax issues (text too close causing features to not render properly etc)
  • remove HTML tags (img, br, a, etc)
  • remove horizontal lines (in markdown: ---) (pandoc transforms this into incorrect typst syntax)
  • remove user's own pinout table (which is identical to what is auto-generated)
  • replace user strings for pinouts in info.yaml with empty string if it contained phrases like "unused", "not used", "N/A" or other variations which indicated the pin was unused
  • escape characters like @ which were interpreted as being a citation by pandoc

- Add image to repo
- Remove own pinout table
- Reduce length of description in `info.yaml`
- Remove dead link and H1 header
- Turn list of pins into actual list
- Remove text from unused pinouts
- Compress and add images to repo
- Add alt text to images
- Remove unused section
- Add "TBC" to test section
- Add space to fix table formatting
- Compress and add images to repo
- Add alt text to images
- Set image widths for PDF
- Remove own pinouts
- Set unused pins to empty string
- Set appropriate heading levels
- Comment out FIXMEs
- Set unused pins to empty string
@urish urish merged commit e489ecb into TinyTapeout:main Oct 7, 2025
1 of 2 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.

2 participants