Minor documentation touch-up #61
Conversation
…FUNARCH23 publication to the documentation, adding links to github and a simple citation to the FUNARCH23 paper.
benknoble
left a comment
benknoble
left a comment
There was a problem hiding this comment.
Thanks! I think this is a worthwhile addition to the documentation.
I wonder if it's worth keeping the line about "declarative API" in conjunction with the terminology from the FUNARCH ’23 paper?
Still, this might help tie the concepts together more clearly for folks who aren't as familiar with the ideas behind the library.
|
|
||
| @(define repo-link | ||
| (link "https://github.com/Bogdanp/racket-gui-easy" "Git repository")) | ||
| @(define easygui-publications-funarch23 |
There was a problem hiding this comment.
I don't remember the details offhand, but there are ways to put citations in Scribble documents (the Racket manuals do this, for example).
There may also be a better link than arXiv, although arXiv is potentially more accessible. See also links collected in this Discourse post.
There was a problem hiding this comment.
There was a problem hiding this comment.
Yes, the accessibility was what I had in mind when I opted for Arxiv.
When added, the bibliography section stood a bit bare. The repo-link is only used once across the docs so I thought I would turn that into a bib-entry too, which makes it more visible overall, especially when arriving to the docs via DrRacket's context sensitive help. There are not many citations in this document and links would appear more consistent and don't break the flow of reading. But in any case, we now have both versions and can decide which one to go for.
…graphy section in Quickstart
|
@benknoble As someone who landed on easy-gui completely from the outside, it all clicked together once Bogdan shared the paper :) |
|
|
||
| @centered[@image[(build-path media "1.1-hello-world.png") #:scale 0.5]] | ||
|
|
||
| @codeblock|{ |
There was a problem hiding this comment.
I think these codeblock reindents were probably not intended
There was a problem hiding this comment.
No :/ DrRacket's Ctrl - I is addictively useful but does not do good all the time.
| @section{Observables} | ||
|
|
||
| @deftech{Observables} are containers for values that may change over | ||
| @deftech{Observable}s are containers for values that may change over |
There was a problem hiding this comment.
I missed this this morning, but deftech works fine with plurals (so you can @deftech{Views} and then use both @tech{view} and @tech{views} to refer to something). I'll fix before merging.
|
Thanks! I've rebased and merged locally. |
3 participants
Added some useful passages from the FUNARCH23 publication to the documentation as well as a citation to the paper, added links to github, minor typos. Tried to keep up with existing conventions wherever necssary (e.g. maintaining
deftechs).