devdocs icon indicating copy to clipboard operation
devdocs copied to clipboard

Update Phalcon version 3 and add Phalcon version 4

Open MasterEnoc opened this issue 4 years ago • 5 comments

  • [x] Updated the versions and releases in the scraper file
  • [x] Ensured the license is up-to-date and that the documentation's entry in the array in about_tmpl.coffee matches it's data in self.attribution
  • [x] Ensured the icons and the SOURCE file in public/icons/your_scraper_name/ are up-to-date if the documentation has a custom icon
  • [x] Ensured self.links contains up-to-date urls if self.links is defined
  • [x] Tested the changes locally to ensure:
    • The scraper still works without errors
    • The scraped documentation still looks consistent with the rest of DevDocs
    • The categorization of entries is still good

Note that version 2 was removed because its documentation pages are no longer available.

MasterEnoc avatar Nov 24 '20 21:11 MasterEnoc

Note that version 2 was removed because its documentation pages are no longer available.

If feasible, we should archive the old versions in devdocs nevertheless…

Syntax highlighting is broken: 2020-11-24-231301

simon04 avatar Nov 24 '20 22:11 simon04

Syntax highlight added and style improved. Proceed to review

MasterEnoc avatar Nov 25 '20 18:11 MasterEnoc

The methods of a class lost their styles…

2020-11-26-230256

simon04 avatar Nov 26 '20 22:11 simon04

This lack of style happened because of the html implemented in the page. Now phalcon docs use 'p' and 'table' tags for methods without any particular id or class, as you can see in the images I'm attaching. Style can be implemented but I have to figure out how since traversing through all the 'p' and 'table' tags would break the style. image image

MasterEnoc avatar Nov 27 '20 17:11 MasterEnoc

Wow. The new phalcon documentation is truly terrible. It's perhaps the worst documentation I've seen so far.

It may actually be easier to contact the Phalcon team and work with them to improve their documentation than fix it on our end.

scherepn avatar Dec 03 '20 04:12 scherepn