Change Details

The[[ https://www.mediawiki.org/wiki/API:FAQ | FAQ page for the MediaWiki AP ]]I is a popular and frequently visited page. In it's current state it is serving as more of a catch-all for information rather than a functional, audience focused user doc. A quick read of the FAQ reveals that it mostly contains three categories of information. - Information about where documentation can be found, how to get help, and how to report a bug. - Information about some actions and functions of that can be preformed with the MediaWiki action API. The information is not extensive or comprehensive. - Information about possible errors and trouble shooting, which isn't readily available elsewhere. I propose splitting the FAQ into 3 or more user oriented guides that cover these topics (roughly): # What is an API? What does it do? What kinds of things can be done with the MediaWiki action API? This could include user stories and examples. # Where to find information about the MediaWiki action API? How do I get help when I can't find the information? # Troubleshooting the MediaWiki action API. What can go wrong and what to do about it? What are the error codes for the MediaWiki Action API? How to report bugs?

The [[ https://www.mediawiki.org/wiki/API:FAQ | FAQ page for the MediaWiki API ]] is a popular and frequently visited page. In its current state it is serving as more of a catch-all for information rather than a functional, audience focused user doc. A quick read of the FAQ reveals that it mostly contains three categories of information. - Information about where documentation can be found, how to get help, and how to report a bug. - Information about some actions and functions that can be performed with the MediaWiki Action API. The information is not extensive or comprehensive. - Information about possible errors and trouble shooting, which isn't readily available elsewhere. I propose splitting the FAQ into 3 or more user oriented guides that cover these topics (roughly): # What is an API? What does it do? What kinds of things can be done with the MediaWiki action API? This could include user stories and examples. # Where to find information about the MediaWiki Action API? How do I get help when I can't find the information? # Troubleshooting the MediaWiki Action API. What can go wrong and what to do about it? What are the error codes for the MediaWiki Action API? How to report bugs?

The [[ https://www.mediawiki.org/wiki/API:FAQ | FAQ page for the MediaWiki AP ]]IAPI ]] is a popular and frequently visited page. In it's current state it is serving as more of a catch-all for information rather than a functional, audience focused user doc. A quick read of the FAQ reveals that it mostly contains three categories of information. - Information about where documentation can be found, how to get help, and how to report a bug. - Information about some actions and functions of that can be preerformed with the MediaWiki aAction API. The information is not extensive or comprehensive. - Information about possible errors and trouble shooting, which isn't readily available elsewhere. I propose splitting the FAQ into 3 or more user oriented guides that cover these topics (roughly): # What is an API? What does it do? What kinds of things can be done with the MediaWiki action API? This could include user stories and examples. # Where to find information about the MediaWiki aAction API? How do I get help when I can't find the information? # Troubleshooting the MediaWiki aAction API. What can go wrong and what to do about it? What are the error codes for the MediaWiki Action API? How to report bugs?