[Openid-specs-fapi] FAPI 1.0 errata edit strategy

[Joseph Heenan]

Hi Nat

This is great progress!

I agree we probably want to change the filenames (to remove financial API) if we’re allowed to do so. I suggest doing that as a separate step.

I think a single commit containing changes needed due to tooling change sounds okay, and should contain only the those changes.

The HTML output shown in https://www.sakimura.org/uploads/fapi1-part1.html arguably does not look as nice as the current specs (the ToC seems to be missing some line breaks, a sans-serif font would be preferable, the document title text looks too big and there seems to be extra space around some text that’s in fixed width fonts). We may want to consider getting a designer, perhaps the team working on the website, to do a quick pass over the CSS etc?

Thanks

Joseph


> On 25 May 2023, at 02:39, Nat Sakimura via Openid-specs-fapi <openid-specs-fapi at lists.openid.net> wrote:
> 
> Hi 
> 
> I am testing out the new toolset - pandoc. 
> So far, it seems to work well. 
> The markdown file is readable as is, and HTML rendering goes fine as well. 
> 
> As an experiment, I have forked the repository and applying edits. You can see them at 
> 
> * repo - https://bitbucket.org/Nat/fapi1/src/master/
> * rendered HTML - https://www.sakimura.org/uploads/fapi1-part1.html
> 
> Questions: 
> --------------------
> 1. We probably want to change the filenames, too, do not we? 
> 2. If experiments go well, could editors apply the changes in a squashed manner at least for the changes needed due to the tooling change? (e.g. metadata section, empty lines, numbering commands) Or do you guys want to see the changes applied step by step through PRs? 
> 
> -- 
> Nat Sakimura
> NAT.Consulting LLC
> _______________________________________________
> Openid-specs-fapi mailing list
> Openid-specs-fapi at lists.openid.net
> https://lists.openid.net/mailman/listinfo/openid-specs-fapi

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openid.net/pipermail/openid-specs-fapi/attachments/20230525/5aebc0cc/attachment.html>