Skip to content

Conversation

@kburger
Copy link
Contributor

@kburger kburger commented Dec 16, 2025

Added an index.bs scaffold to demonstrate the use of bikeshed. Locally this can be run using:

bikeshed spec index.bs output.html

Note that the output is not on par with the existing index.html, because bikeshed is opinionated. With some css we can probably get closer, but that is out of scope for this PR.

Up for discussion:

  • folder/file structure and naming convention (folder per chapter, .md file naming)
  • bikeshed metadata (which keys to use, what values to pick)
  • look-and-feel
  • github action automation (see https://speced.github.io/bikeshed/#gh-action-ci)

fixes #19 (?)

@kburger kburger force-pushed the feature/bikeshed-scaffolding branch from 6ac6044 to ceced02 Compare December 16, 2025 12:40
@kburger kburger force-pushed the feature/bikeshed-scaffolding branch from ceced02 to ddc5b6f Compare December 16, 2025 12:41
@kburger
Copy link
Contributor Author

kburger commented Jan 14, 2026

I'm converting the remaining chapters in this PR to keeps things together.

@kburger kburger marked this pull request as ready for review January 14, 2026 14:46
@kburger
Copy link
Contributor Author

kburger commented Jan 14, 2026

@luizbonino and @dennisvang, i'm looking for feedback on setup, naming, and what we're missing out on look and feel.

@dennisvang dennisvang changed the title feat: bootstrap bikeshed with first two chapters feat: bootstrap bikeshed Jan 15, 2026
@dennisvang
Copy link
Contributor

dennisvang commented Jan 15, 2026

Hi @kburger, looks good already. :)

Not done reviewing, but some notes for now:

  • I've added some project dependencies for local dev in Specify project dependencies #21. Just a suggestion.
  • One thing I've noticed in the bikeshed output is that a "Conformance" section is generated, near the bottom.
    In the new spec we should probably move the info from the "Compliance" section into that "Conformance" section, and move it to the top somewhere.
  • Would it be possible to convert the tables to markdown too, instead of html? I know this will lead to long lines of text again, but in this case I'm inclined to prefer readability of the raw markdown document.

* add .gitignore

* add minimal pyproject.toml with bikeshed dev dependency

* add uv.lock (showing a preference for using astral-sh/uv to manage python and packages)
@kburger
Copy link
Contributor Author

kburger commented Jan 19, 2026

@dennisvang bikeshed support commonmark, which does not include tables (see speced/bikeshed#2857 and speced/bikeshed#1128). When a markdown table is written once, and read many times I agree, but if a table needs frequent updates the maintenance of a markdown table can be cumbersome.

For the conformance section, I think it can be influences by configuration settings. That would be something to investigate.

@dennisvang
Copy link
Contributor

@dennisvang bikeshed support commonmark, which does not include tables (see speced/bikeshed#2857 and speced/bikeshed#1128). [...]

Thanks for pointing that out. I was not aware that md tables are not supported.

[...] When a markdown table is written once, and read many times I agree, but if a table needs frequent updates the maintenance of a markdown table can be cumbersome.

Yes you're right.

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.

Use the W3C bikeshed tool

3 participants