Welcome Guest, Not a member yet? Register   Sign In
Split User Guide from Framework repository
#1

Hi All,

I think that it will be good to split the framework from the userguide at Git.
Yes they are both about the Framework, but there is no point to have them in 1 repository.
Each release will have both at zip files, and when somebody uses composer we can add the userguide as suggestion package.

Regards
Best VPS Hosting : Digital Ocean
Reply
#2

I think it would not be good to split the documentation, because code changes have to have the corresponding documentation changes. If they are separate, that would be a lot harder to manage code updates.

When the release bundle is prepared, the "built" userguide will be included.

Right now, I periodically update the user guide on the website, and its zip.
Reply
#3

I like them together, that way, I know that I always have the correct documentation for the version in my project.

The web version will change, but the version in my project is correct.

I like it this way, it creates a nice level or assurance, particularly if you need an old version of a project from source control, it comes complete with the correct documentation.
Reply




Theme © iAndrew 2016 - Forum software by © MyBB