Re: [racket-users] Wanted: Easier way to contribute docs

> > This is a nice idea, though possibly complicated to implement (AFAICT it > would require annotating the HTML of a given part of the documentation with > a reference to the source code that originally generated it, and in a way > that can be generalized to every Racket project, not just the

Re: [racket-users] Wanted: Easier way to contribute docs

FWIW For a casual contributor wanting to report a single spelling error, add a single sentence or similar - the Github pencil seems to be an easy way of making a pull request. https://github.com/racket/racket/blob/master/pkgs/racket-doc/scribblings/guide/begin.scrbl See the pencil at the right

Re: [racket-users] Wanted: Easier way to contribute docs

> On Jun 13, 2017, at 6:34 AM, David Storrs wrote: > > There needs to be an easy and obvious way to edit the pages at > docs.racket-lang.org or an easy and obvious > way to go from the page to the relevant part of the GitHub repository

Re: [racket-users] Wanted: Easier way to contribute docs

> A lot of sites show a hyperlink icon (two chain links typically) when you > mouse over a section title. We could do that along with an edit icon instead > of requiring users click the section header. That would be more discoverable > and more in line with what other sites like Github do IMO.

Re: [racket-users] Wanted: Easier way to contribute docs

> It might also be a good idea to have the documentation generator put a > standard sentence at the top of each page: "Click on a section header to find > out how to link to it or edit it." A lot of sites show a hyperlink icon (two chain links typically) when you mouse over a section title. We

Re: [racket-users] Wanted: Easier way to contribute docs

Yep, that would be fine. It might also be a good idea to have the documentation generator put a standard sentence at the top of each page: "Click on a section header to find out how to link to it or edit it." On Tue, Jun 13, 2017 at 9:38 AM, Leif Andersen wrote: > When

Re: [racket-users] Wanted: Easier way to contribute docs

When you click on a section title, something like this pops up: Link to this section with @secref["sync" #:doc '(lib "scribblings/reference/reference.scrbl")] Would it be sufficient to also have: Edit this section at: I know its not ideal, but this seems like the easiest possible way to go

[racket-users] Wanted: Easier way to contribute docs

I've mentioned this on list before but wanted to bump it: It is too difficult to contribute to the Racket docs. There needs to be an easy and obvious way to edit the pages at docs.racket-lang.org or an easy and obvious way to go from the page to the relevant part of the GitHub repository. I