Move *all* website texts to one central place/repo #6063
Replies: 3 comments 1 reply
-
I don't like this proposal at all. It is a sad fact, but documentation is a by-product of the code here. The worst case scenario is if someone makes change in lib-innerbrowser, then that change must be manually documented in all framework pages. I would rather move guide files back to codeception/codeception. P.S. I could use some help with documenting operators in DB module: Codeception/module-db#12 |
Beta Was this translation helpful? Give feedback.
-
Yeah, that's certainly a point I was missing... Then let's go the opposite route:
|
Beta Was this translation helpful? Give feedback.
-
The only autogenerated pages missing links to source are Commands, Stub and Mock. Please update static files and I will update autogenerated files.
I think that this is an overkill and unnecessary links will make documentation harder to read. Here is a walkthrough if you aren't using IDE:
When I clicked on addServiceToContainer, comment in FunctionalTesterActions said How about adding something along the lines of "Majority of actions are inherited from InnerBrowser" below yellow alert box? |
Beta Was this translation helpful? Give feedback.
-
"Where is the text of this web page coming from?" is one of the most confusing Codeception questions for me ;-) So I'm suggesting to set up a central repository for all website content.
Module pages are coming from the module's source code. I see the original advantage of having everything (=code and documentation) in one place. But I think meanwhile the cons outweigh the pros:
Reference pages are coming from some source code too - see Adding
vendor/bin/
codeception.github.com#400 (comment) - and there's not even a hint about that on the page.Guides are coming from https://github.com/Codeception/codeception.github.com - even @DavertMik confuses this sometimes, see Update 03-AcceptanceTests.md codeception.github.com#366 (comment) ;-)
So in total this system is obscure and unwelcoming to new contributors. So I'm suggesting to move everything to https://github.com/Codeception/codeception.github.com
Beta Was this translation helpful? Give feedback.
All reactions