Documentation desperately needed for 0.4.0

0 views
Skip to first unread message

Tyler Kahn

unread,
Jun 26, 2010, 3:05:54 AM6/26/10
to Compojure
Nearly 95% of all information that I have found on Compojure is
outdated for the 0.4.0 release. This seems like a great tool but I
can't get past a simple "Hello, World"!


Thanks for your work,
Tyler

Nebojsa Stricevic

unread,
Jun 26, 2010, 6:28:17 AM6/26/10
to comp...@googlegroups.com
Greetings,

I agree that Compojure need more documentation i as far as I know that is high priority goal for author too. Since than, you can start with old stuff and examples from blogs and this list thread:

http://groups.google.com/group/compojure/browse_thread/thread/234d0cb0b0a88f7a/16a11872b7cb81e7?hl=en&lnk=gst&q=0.4#16a11872b7cb81e7

Also, I have found this group and community more than helpful.


--
You received this message because you are subscribed to the Google Groups "Compojure" group.
To post to this group, send email to comp...@googlegroups.com.
To unsubscribe from this group, send email to compojure+...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/compojure?hl=en.




--
Nebojša Stričević

James Reeves

unread,
Jun 26, 2010, 9:07:24 AM6/26/10
to comp...@googlegroups.com
On 26 June 2010 08:05, Tyler Kahn <tka...@gmail.com> wrote:
> Nearly 95% of all information that I have found on Compojure is
> outdated for the 0.4.0 release. This seems like a great tool but I
> can't get past a simple "Hello, World"!

Documentation is currently my top priority.

One of the problems with documenting Compojure is that much of its
functionality has been factored out into other libraries. From a
technical perspective, this is a good thing. From a documentation
perspective, it means that useful documentation is now spread across a
number of different sources.

To solve this issue, I have just started work on a book that will
provide developers a detailed overview of how to use all of these
separate libraries. I hope to eventually make it as comprehensive as
the Git community book.

I'm using Google docs to write the first draft. It's still in a
**very** rough state, but it'll gradually improve. The read-only link
is:

https://docs.google.com/Doc?docid=0AQqGP1CDN0uIZGhmZjJmcGZfMjNjNHIycGZu&hl=en

If anyone wants to help me write the documentation, drop me an email
and I'll give you write access.

Until the book is more complete, here are some alternative sources of
documentation:

http://mmcgrana.github.com/2010/03/clojure-web-development-ring.html
http://weavejester.github.com/compojure/docs/routes-in-detail.html

(It looks like GitHub's Jekyll is a bit broken. The latest build of
the Compojure page has \ns everywhere. I'll try and fix it later).

- James

>
> Thanks for your work,
>   Tyler
>

Tyler Kahn

unread,
Jun 26, 2010, 9:21:13 AM6/26/10
to Compojure
Yes I did see in the course of trying to compile a few examples that
Compojure is now factored out into libraries. I'm sure this makes for
a much cleaner and more logical architecture.

I really appreciate the link to your rough draft. I will definitely
make use of this group if I have any questions.

Thanks again,
Tyler



On Jun 26, 9:07 am, James Reeves <jree...@weavejester.com> wrote:
> On 26 June 2010 08:05, Tyler Kahn <tka...@gmail.com> wrote:
>
> > Nearly 95% of all information that I have found on Compojure is
> > outdated for the 0.4.0 release. This seems like a great tool but I
> > can't get past a simple "Hello, World"!
>
> Documentation is currently my top priority.
>
> One of the problems with documenting Compojure is that much of its
> functionality has been factored out into other libraries. From a
> technical perspective, this is a good thing. From a documentation
> perspective, it means that useful documentation is now spread across a
> number of different sources.
>
> To solve this issue, I have just started work on a book that will
> provide developers a detailed overview of how to use all of these
> separate libraries. I hope to eventually make it as comprehensive as
> the Git community book.
>
> I'm using Google docs to write the first draft. It's still in a
> **very** rough state, but it'll gradually improve. The read-only link
> is:
>
> https://docs.google.com/Doc?docid=0AQqGP1CDN0uIZGhmZjJmcGZfMjNjNHIycG...
>
> If anyone wants to help me write the documentation, drop me an email
> and I'll give you write access.
>
> Until the book is more complete, here are some alternative sources of
> documentation:
>
> http://mmcgrana.github.com/2010/03/clojure-web-development-ring.htmlhttp://weavejester.github.com/compojure/docs/routes-in-detail.html

Abhishek Reddy

unread,
Jun 26, 2010, 6:01:29 PM6/26/10
to comp...@googlegroups.com
I'd also point you to the IRC channel #compojure on Freenode.  As documentation has been thin for a long time, a lot of folks have asked for help in the channel, with some success, particularly for getting started or migrating to 0.4.
--
Abhishek Reddy
http://abhishek.geek.nz


cageface

unread,
Jun 27, 2010, 4:16:18 PM6/27/10
to Compojure
The getting started page on compojure.org seems to have a rendering
problem:
http://weavejester.github.com/compojure/docs/getting-started.html

Is this page outdated or is it still a primary reference?

James Reeves

unread,
Jun 27, 2010, 4:26:55 PM6/27/10
to Compojure
Fixed. Looks like it was a problem on GitHub's end. Pushing the
repository again seems to have fixed it.

- James

cageface

unread,
Jun 27, 2010, 5:33:30 PM6/27/10
to Compojure
On Jun 27, 1:26 pm, James Reeves <weavejes...@googlemail.com> wrote:
> Fixed. Looks like it was a problem on GitHub's end. Pushing the
> repository again seems to have fixed it.

Yeah looks ok here. Thanks.
Reply all
Reply to author
Forward
0 new messages