Differences

This shows you the differences between two versions of the page.

--- start [2007/05/06 19:58]
gsnedders
+++ start [2013/08/11 04:43] (current)
@@ Line 1: / Line 1: @@
-====== Who? What? How? ======
+====== Documentation ======
 We've seen far too many open-source projects have really poor documentation, if any at all. We don't want to be like that. Our goal is to provide you with everything you need to install, upgrade, get started with, and really push SimplePie to its limits.
-Besides documenting each and every single public function, we've also put together guides for various things to help you along. We've opened up comments on our documentation pages so that if something isn't clear or if you have something further to add, you can add it yourself (much like [[http://php.net/|php.net]]).
+Besides documenting each and every single public function, we've also put together guides for various things to help you along. We decided to move everything into a wiki so that people can add their own notes, clarifications, and other helpful hints to the docs.  Feel free to add your own tutorials and such, but please follow existing uses of wiki links and the [[http://simplepie.org/api/|API documentation]].
+:!: **You can look up a specific class or method by going to http://simplepie.org/api/[class name]** which is just like how you can look up PHP functions by going to http://php.net/[function name].
 Ready to learn? You can begin by clicking on one of the documentation links below.
-  * [[Requirements, Setup, and Installation]]
+===== Frequently Asked Questions =====
-  * [[Upgrade Guide]]
+  * **[[faq:start]]**
-  * [[SimplePie Plugin Installation and Usage Instructions]]
+  * [[faq:Typical Multifeed Gotchas]]
-  * [[Function Reference]]
+  * [[faq:problematic_feeds]]
-  * [[Miscellaneous Documentation]]
+  * [[faq:I'm getting memory leaks]]
+  * [[faq:how_does_simplepie_s_caching_http_conditional_get_system_work]]
+  * [[faq:file_permissions|How do I change the file permissions for the cache directory to be server-writable?]]
+===== Setup =====
+  * [[setup:start]]
+  * [[setup:sample_page]]
+  * [[setup:upgrade]]
+===== Usage =====
+  * [[http://simplepie.org/api/|API Documentation for 1.3]]
+  * [[1.3:start|Other Documentation for 1.3]]
+  * [[reference:start|API Documentation for 1.2]]
+  * [[tutorial:start]]
+  * [[ideas:start]]
+===== Enhancements =====
+  * [[plugins:start]]
+  * [[addons:start]]
+===== Miscellaneous =====
+  * [[misc:Coding Standards]]
+  * [[misc:Release Notes:start]]
+  * [[misc:Credits]]
+  * [[misc:In The Media]]
+===== SimplePie Live! Documentation =====
+  * [[live:start]]

start.txt · Last modified: 2013/08/11 04:43 (external edit)