IRC client

[Stanislav Palatnik]

Do the GSOC Django mentors/admins have an IRC client setup? I want to
discuss a new idea, or better with a mentor directly.

[Benjamin Slavin]

Hi Stanislav,

We don't have an official IRC channel setup for django-gsoc.

The idea for this mailing list is to discuss ideas in an open setting
so we can help make sure you get access to the right people.

Is there a reason you don't want to discuss the idea here?

Thanks,
- Ben

[Stanislav Palatnik]

I don't mind at all :) I just thought an IRC channel would provide
more natural communication.

Well here's my idea:

I was inspired by Django's instant Admin Interface feature. It helps
you tie everything together so much easily. My idea is to create a
feature that creates an automatic documentation interface. For
example, if you have a product or software that needs alot of
explaining, you can activate this feature and create help files
easily.

I think this client software best explains it :

http://www.drexplain.com/software-documentation-tool/


How would it work?

I would base it on PHP's PhD script. It sets a really powerful
standard. Ofcourse I would have to write a python version of it.



Goals:

Integration into Django would provide instant documentation setup to
integrate seemlessly into your site. In addition, if a user clicks an
unknown definition on ANY Django page, he will be redirected to the
approproate help file. ( Think of Wikipedias highlighted words).

http://doc.php.net/wiki/phd

I want to consult a mentor on this because I don't know if this
borders middleware, which doesn't improve the core function of Django,
or if a similiar function already exists.


Thank You

Stanislav Palatnik

On Mar 25, 10:53 pm, "Benjamin Slavin" <benjamin.sla...@gmail.com>
wrote:

[Stanislav Palatnik]

Anyone =) ?

Should I start a new topic with it.

[Brian Rosner]

> I was inspired by Django's instant Admin Interface feature. It helps
> you tie everything together so much easily. My idea is to create a
> feature that creates an automatic documentation interface.  For
> example, if you have a product or software that needs alot of
> explaining, you can activate this feature and create help files
> easily.

I don't mean to shoot down your idea, but this mostly exists. The
admin interface provides a documentation link that is able to
introspect your code for docstrings and other bits then produce
documentation. I just don't see this idea going very far. There are
already great tools that provide generic ways to perform this type of
automatic creation of documentation. http://sphinx.pocoo.org/ is one I
can think of right now.

> Integration into Django would provide instant documentation setup to

> integrate seamlessly into your site. In addition,  if a user clicks an

> unknown definition on ANY Django page, he will be redirected to the
> approproate help file. ( Think of Wikipedias highlighted words).

I think this would really be something that Django should enable you
to do in your own projects. In which case it already does.

I am not trying to discourage you in pursuing GSoC, but this idea is
probably not the best. I am willing to provide any feedback you are
looking for on any of your ideas :)