I have a dumb question. Why can't doc pages have links whose label is
something like "Want to improve the docs?", and the URL goes directly
to the appropriate .scrbl file on GitHub?
- A .scrbl file knows its own syntax source file path.
- defmodule forms know how to make links to the package server.
- The package server has a catalog that knows where the source repo is.
- Often it knows, when a pkg is split -{lib doc test}, where the -doc
repo for a -lib is (although ironically "Documentation" for
scribble-lib is blank when I check now.)
Could these elements be combined to provide the direct link on the doc page?
Admittedly people still need to know how to use GitHub and do a PR.
But I think in my own case, the main speed bump feels like finding the
scrbl file to modify. If that were one click, I'd be more likely to
act even on low ROI tiny prose typos I might notice.
On Fri, Mar 8, 2019 at 11:52 AM Matthew Butterick <m...@mbtype.com> wrote:
>
> Perhaps this would be good material for a CONTRIBUTING.md at the top level of
> the repo, where it would be more likely to be found by future contributors.
> GitHub will automatically show a link to the file at arguably appropriate
> times. [1]
>
> [1] https://github.blog/2012-09-17-contributing-guidelines/
>
> > On Mar 8, 2019, at 8:44 AM, Marc Kaufmann <marc.kaufman...@gmail.com> wrote:
> >
> > Let me (ab)use this thread to add some more details on how to submit pull
> > requests (PR) on GitHub to racket using the GitHub web interface for other
> > noobs - which includes myself in another month or two. Ideally I would
> > write this up elsewhere to help with onboarding, but that won't happen
> > soon, so here we go. We are talking ELI5 (Explain Like I'm 5) level
> > explanations, so this will be painfully obvious to the vast majority
> > (although it would be good for someone who knows what they are doing to
> > correct whatever kludgy workflow I've come up with). I copy most of the
> > steps from Paulo earlier, but add some that I still had to figure out.
>
> --
> You received this message because you are subscribed to the Google Groups
> "Racket Users" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to racket-users+unsubscr...@googlegroups.com.
> For more options, visit https://groups.google.com/d/optout.
--
You received this message because you are subscribed to the Google Groups
"Racket Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to racket-users+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
