Single file version available here.
Last updated on 2008-05-28.
To discuss, comment here.
| Prev | Next | |
| Home |
I've been learning symfony over the last couple of weeks for a project I'm developing. I'm finally getting the hang of it, and am pretty impressed with the platform. I would have to say the biggest problems I encountered when I started to delve into the framework were due to not being aware of where the API documentation was.
Worst of all the search box (and Google in general) does not seem to index the API. When looking for function definitions I would search the symfony site for "link_to" or "input_tag". The search returned no relevant results.
Google works pretty well:
keyword site:http://www.symfony-project.org/api/
For example:
link_to site:http://www.symfony-project.org/api/
Returns the www.symfony-project.org/api/symfony/helper/UrlHelper.html page
documented on: 22 February 2007, marckohlbrugge
That's true, but it does rely on users knowing the exact location of the API. Once they know that then browsing to a page is probably easier than searching Google for it.
I have just realized that the search box on the documentation page is labeled "Search in the Book". I had assumed that the search box searched *all* available documentation. That prompted my initial post. I had assumed that going to "documentation" and searching for a function name would produce all results that would be relevant.
documented on: 22 February 2007, joshd
Speaking of the Symfony API, you might want to check out http://www.gotapi.com which includes it in their offerings.
documented on: 22 February 2007, jhall
| Prev | Next | |
| Home |