Re: [racket-users] How to fix typos in documentation?

2019-03-11 Thread Gustavo Massaccesi
I just want to clarify that if someone finds an error in the docs or a bug, it's perfectly fine to just send a bug report: * Inside Racket: Go to the menu > About > Submit Bug Report ... * In Github: Submit an "Issue" Please include enough information to reproduce the bug. For example for a

Re: [racket-users] How to fix typos in documentation?

2019-03-09 Thread Marc Kaufmann
I agree with Greg that such a feature would be neat - so it's great that Ben and Kieran are on it already. (Thanks!) The CONTRIBUTING.md is a good idea (and I David's version). The 'Edit on Github' button would solve the first stumbling block I hit, while the contribution.md file helps later in

Re: [racket-users] How to fix typos in documentation?

2019-03-08 Thread Ben Greenman
On 3/8/19, David Storrs wrote: > On Fri, Mar 8, 2019 at 3:13 PM Greg Hendershott > wrote: > >> 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? >> > > I

Re: [racket-users] How to fix typos in documentation?

2019-03-08 Thread David Storrs
On Fri, Mar 8, 2019 at 3:13 PM Greg Hendershott wrote: > 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? > I asked about this a year or so ago and the

Re: [racket-users] How to fix typos in documentation?

2019-03-08 Thread David Storrs
Thank you for that writeup, Marc. I've wanted to offer doc changes several times but never had the spoons to figure out how. Matthew, I think you're absolutely right: putting this in a CONTRIBUTING file would be great. I've created one and submitted a pull request. :> On Fri, Mar 8, 2019 at

Re: [racket-users] How to fix typos in documentation?

2019-03-08 Thread Greg Hendershott
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

Re: [racket-users] How to fix typos in documentation?

2019-03-08 Thread Matthew Butterick
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]

Re: [racket-users] How to fix typos in documentation?

2019-03-08 Thread Marc Kaufmann
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,

Re: [racket-users] How to fix typos in documentation?

2019-03-07 Thread Marc Kaufmann
Ergh, of course I forgot to do that part. Thanks for catching that. On Thu, Mar 7, 2019 at 1:59 PM Paulo Matos wrote: > > > On 07/03/2019 13:40, Marc Kaufmann wrote: > > Thanks Paulo, this is way better than the workflow I used the only other > > time I made a PR. The only thing I had to do was

Re: [racket-users] How to fix typos in documentation?

2019-03-07 Thread 'Paulo Matos' via Racket Users
On 07/03/2019 13:40, Marc Kaufmann wrote: > Thanks Paulo, this is way better than the workflow I used the only other > time I made a PR. The only thing I had to do was choose a branch to > commit to: I chose 'master', mostly because I have no clue what else I > would have chosen. What is the

Re: [racket-users] How to fix typos in documentation?

2019-03-07 Thread 'Paulo Matos' via Racket Users
On 07/03/2019 13:40, Marc Kaufmann wrote: > Thanks Paulo, this is way better than the workflow I used the only other > time I made a PR. The only thing I had to do was choose a branch to > commit to: I chose 'master', mostly because I have no clue what else I > would have chosen. What is the

Re: [racket-users] How to fix typos in documentation?

2019-03-07 Thread Marc Kaufmann
Thanks Paulo, this is way better than the workflow I used the only other time I made a PR. The only thing I had to do was choose a branch to commit to: I chose 'master', mostly because I have no clue what else I would have chosen. What is the default to contribute to? It was in scribblings by the

Re: [racket-users] How to fix typos in documentation?

2019-03-07 Thread 'Paulo Matos' via Racket Users
On 07/03/2019 11:55, Marc Kaufmann wrote: > Hi, > > I just came across a typo in the documentation and was about to move on > simply because I couldn't be bothered to figure out how/where to change > it. I couldn't find the docs in the github repo (I searched for doc, and > looked under