#151 enhancement
Dan Dean

Create updated and more useful API index page

Reported by Dan Dean | February 25th, 2010 @ 08:33 PM

The current api index page http://api.prototypejs.org/ is generated using the content of the README.markdown file in GitHub http://github.com/sstephenson/prototype/blob/master/README.markdown.

We should decide what really should live on the index page for the API as it doesn't necessarily map to what is needed in the git readme file. As the two should really serve two different purposes:

  • The API Index page should function as an introduction to the API docs, serving as a tool for people looking for information on how to use Prototype and the Prototype docs. Key responsibility: serve Prototype Users.
  • The GitHub README should serve as a source of information about the repo, including specific details about how to get involved and contribute to Prototype. Key responsibility: serve Prototype Developers.

Side note: a small part of the content for the API index page could include this content: #110 .

Comments and changes to this ticket

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.

New-ticket Create new ticket

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile »

Shared Ticket Bins

Referenced by

Pages