how best to contribute to docs ...

62 views
Skip to first unread message

Thomas Lynch

unread,
Apr 24, 2015, 4:57:23 AM4/24/15
to racke...@googlegroups.com
Hello,  I would like to type on some of the manuals with the benefit of someone reading them fresh.  Of course my edits will be highly suspect and should be reviewed.  I would also like to write an article on the "The Wonderful But Highly Under-Appreciated Tree Access Language of car and cdr" which if turns out well where would it go?  So I guess this all starts with fork on github then a clone or some such.  Someone kind enough to tell me the commands?  (I also want to star hacking match, which I promised to do.  I'm reading Sam's paper now.  So I guess that would be a separate fork and clone ..)

Jens Axel Søgaard

unread,
Apr 24, 2015, 10:01:18 AM4/24/15
to Thomas Lynch, racke...@googlegroups.com
To fix a small typo, the fastest way to submit a fix is to use the pencil in Github.
See the attached screen shot.

For other docs, clone the relevant github repository.

For the actual commands, see


I am not 100% sure that everything is up-to-date though.

/Jens Axel




2015-04-24 10:57 GMT+02:00 Thomas Lynch <thomas...@reasoningtechnology.com>:
Hello,  I would like to type on some of the manuals with the benefit of someone reading them fresh.  Of course my edits will be highly suspect and should be reviewed.  I would also like to write an article on the "The Wonderful But Highly Under-Appreciated Tree Access Language of car and cdr" which if turns out well where would it go?  So I guess this all starts with fork on github then a clone or some such.  Someone kind enough to tell me the commands?  (I also want to star hacking match, which I promised to do.  I'm reading Sam's paper now.  So I guess that would be a separate fork and clone ..)

--
You received this message because you are subscribed to the Google Groups "Racket Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to racket-dev+...@googlegroups.com.
To post to this group, send email to racke...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/racket-dev/762d6c75-1475-4505-9834-fa627323b0b7%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.



--
--
Jens Axel Søgaard

Greg Hendershott

unread,
Apr 28, 2015, 11:44:44 AM4/28/15
to Jens Axel Søgaard, Thomas Lynch, racke...@googlegroups.com
> For the actual commands, see
>
>
> http://www.greghendershott.com/2013/04/a-guide-for-infrequent-contributors-to-racket.html
>
> I am not 100% sure that everything is up-to-date though.

I _believe_ that's still accurate for the (now much smaller) main
plt/racket repo.

But I haven't yet gotten hands-on with stuff, post-split. Haven't
tried things like the new "clone" option to raco pkg.

In other words I haven't yet had the opportunity to get confused and
make mistakes -- which is generally how I end up writing stuff like
that. :)

Just this morning I submitted a small doc PR... but it happened to be
in the main repo, so this wasn't the opportunity.

Thomas Lynch

unread,
May 6, 2015, 12:11:37 AM5/6/15
to racke...@googlegroups.com, jens...@soegaard.net, thomas...@reasoningtechnology.com
Hello Greg,

So I thought I would push the few edits I have for the module-guide.  The clone and make went just fine as according to 


Though it appears there is now another level, so I had to go to racket/racket/src  rather than racket/src to create the build directory.  Or perhaps the directions just assumed I was already in the top level racket.

However, I do run into problems trying to make the docs.  I'm running this on a fresh clone, haven't made any edits anywhere in the tree.  This is the "Adding Documentation" section of the above, just after "To build the docs, we run:"

§lambda1:~/racket/racket> ./bin/raco setup collects/rackunit
collection-path: collection not found
  collection: "collects/rackunit"
  in collection directories:
   /home/mordecai/.racket/6.2.0.3/collects
   /home/mordecai/racket/racket/collects

I send this along as an FYI.  It isn't holding anything up at this point.
Reply all
Reply to author
Forward
0 new messages