History

Updated Adding documentations to DevDocs (markdown => mediawiki)

sterbalr committed 8 years ago

Commit 68e12ca1 parent 56b75ca1 file · +3 −1Browse files

Unified · Split

Adding-documentations-to-DevDocs.mediawikirenamed from Adding-documentations-to-DevDocs.md+3−1
@@ -21,4 +21,6 @@ Adding a documentation may look like a daunting task but once you get the hang o · 20 unmodified lines
21 21
22If the documentation includes more than a few hundreds pages and is available for download, try to scrape it locally (e.g. using `FileScraper`). It'll make the development process much faster and avoids putting too much load on the source site. (It's not a problem if your scraper is coupled to your local setup, just explain how it works in your pull request.)22If the documentation includes more than a few hundreds pages and is available for download, try to scrape it locally (e.g. using `FileScraper`). It'll make the development process much faster and avoids putting too much load on the source site. (It's not a problem if your scraper is coupled to your local setup, just explain how it works in your pull request.)
23 23
24Finally, try to document your scraper and filters' behavior as much as possible using comments (e.g. why some URLs are ignored, HTML markup removed, metadata that way, etc.). It'll make updating the documentation much easier.24Finally, try to document your scraper and filters' behavior as much as possible using comments (e.g. why some URLs are ignored, HTML markup removed, metadata that way, etc.). It'll make updating the documentation much easier.
25
26return [[Home]]