<div dir="ltr"><div dir="ltr"><div class="gmail_default" style="font-family:times new roman,serif;font-size:large">Great idea, Ben. It would also make getting started less intimidating particularly if it had sections on changing the doc and adding test cases. The latter areas would be a good way for non experts to help move ghc forward. Of course those processes would ideally not involve building ghc. Less expert software developers are experts on what needs more explanation for less sophisticated developers  in e.g. the  hackage doc. Similarly many people who submit bugs can't fix them but they could write a test case.</div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, Jul 20, 2022 at 1:01 PM Ben Gamari <<a href="mailto:ben@smart-cactus.org">ben@smart-cactus.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Rodrigo Mesquita <<a href="mailto:rodrigo.m.mesquita@gmail.com" target="_blank">rodrigo.m.mesquita@gmail.com</a>> writes:<br>
<br>
> Dear Ben,<br>
><br>
> The list of tips you put together is quite nice.<br>
><br>
> I suggest we add it to hadrian’s wiki page under a “Tips for making<br>
> your life easier” section (as is, it is already useful! at least I<br>
> learned something new).<br>
><br>
Hi Rodrigo,<br>
<br>
I'm happy to hear that it was useful! Indeed I always struggle to know<br>
where to put this information; our developer documentation is quite<br>
scattered and it's hard to know where new contributors will enter it.<br>
Nevertheless, the page that you mention seems like an obvious place for<br>
these tips.<br>
<br>
Incidentally, I have long felt that migrating the Wiki documentation<br>
into a comprehensive developer's guide (see #18853) in the repository<br>
(much like the Rustc Book [1]) would be a useful direction of travel. It<br>
would be both prompt us review (and, in some cases, retire) existing and<br>
give us the opportunity to structure the documentation in a more<br>
coherent manner. Moreover, the fact that it would be part of the<br>
repository would both give us the benefit of code review and make it<br>
easier to ensure that the documentation remains consistent with the<br>
code. This is obviously a longer-term goal, but one which it would be<br>
great to have help in moving towards.<br>
<br>
Cheers,<br>
<br>
- Ben<br>
<br>
<br>
[1] <a href="https://doc.rust-lang.org/rustc/contributing.html" rel="noreferrer" target="_blank">https://doc.rust-lang.org/rustc/contributing.html</a><br>
_______________________________________________<br>
ghc-devs mailing list<br>
<a href="mailto:ghc-devs@haskell.org" target="_blank">ghc-devs@haskell.org</a><br>
<a href="http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs" rel="noreferrer" target="_blank">http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs</a><br>
</blockquote></div></div>