W3C home > Mailing lists > Public > public-credentials@w3.org > September 2020

Re: Weekend Project: ReSpec GitHub Pages

From: Kim Hamilton <kimdhamilton@gmail.com>
Date: Sun, 20 Sep 2020 16:57:07 -0700
Message-ID: <CAFmmOzf9+xuWtj1F4FSgDdotCb-RWeHPJPJS4TMBCrcYmfa9Yw@mail.gmail.com>
To: Orie Steele <orie@transmute.industries>
Cc: "W3C Credentials CG (Public List)" <public-credentials@w3.org>
wherever it lives -- and Wayne and I can play with this first -- we should
probably add this template as a starting point option* when creating future
work items. It would probably be desired in almost all cases...

*Not that Orie writes bugs. But if there are bugs, I imagine the chairs
would be incentivized to accept that risk and help fix them, since it will
boost collective productivity.


On Sun, Sep 20, 2020 at 4:48 PM Kim Hamilton <kimdhamilton@gmail.com> wrote:

> Orie, this is incredible, and great timing as well, as we're looking to
> make it easier for people to create CCG artifacts. I will happily
> help maintain this, and we can adopt it as a ccg repo if you'd like.
>
> As usual, your weekend coding projects put my weekend "code-ling" projects
> to shame. If I wait long enough, you always eventually write the code I
> need...
>
> On Sun, Sep 20, 2020 at 4:40 PM Orie Steele <orie@transmute.industries>
> wrote:
>
>> Made a GitHub Template repository that makes technical specification
>> development with ReSpec even easier:
>>
>> https://github.com/transmute-industries/respec-github-pages
>>
>> New Features
>>
>> - Support for GitHub Markdown and HTML
>> - Automatic SEO / feed / sitemap support in XML (including schema.org /
>> jsonld)
>> - Guidance for hosting JSON files alongside spec text.
>> - Support for multiple versions that can share the same configuration
>> files
>> - Support for multiple Specs that can share the same configuration files
>> - Relies on GitHub Pages, so documentation for "how to do things" is
>> already provided by them.
>> - No need to "build the spec" like is needed with bikeshed, github does
>> this for you, and automatically notifies you when it's done (no workflows
>> or CI needed).
>>
>> Dependencies
>>
>> Just uses ReSpec and GitHub.... so there is no "source code"... it's just
>> a configuration of free existing tooling.
>>
>> If you really need to, you can edit 100% of the source files in the
>> github repo, just like you had to before...
>> If you don't need to configure ReSpec, you don't need to even see it, and
>> you can use markdown to quickly sketch your spec up.
>>
>> I opened an issue on respec, trying to find a better home for the repo /
>> template.
>>
>> Not sure where it belongs, but hopefully some other github organization
>> with more maintainers : )
>>
>> OS
>>
>> --
>> *ORIE STEELE*
>> Chief Technical Officer
>> www.transmute.industries
>>
>> <https://www.transmute.industries>
>>
>
Received on Sunday, 20 September 2020 23:57:31 UTC

This archive was generated by hypermail 2.4.0 : Thursday, 24 March 2022 20:25:03 UTC