Use Github Pages instead of Wiki for docs about typo3-realurl HOT 5 OPEN

I do not see an issue.

Firsts, documentation does not depend much on code changes. There were many code changes in the past but the manual was updated just a couple of times and it mostly was unrelated to code changes.

Secondly, github pages are in the separate repo. so I am not sure how text documentation will update a separate repo with proper textual information.

Thirdly, I am comfortable with wiki because it is right here and it also can be cloned as a separate repo for offline editing.

What do I miss?

No any REST documentation is planned because:

• There is no normal editor for it
• There is no normal viewer/reader for it

Not worth for a free project.

from typo3-realurl.

No, Github pages are in the same repository but a different branch (gh-pages), thus easy to update.

I don't see an advantage of cloning two repositories (code & wiki) vs one (code+wiki). ;-)

from typo3-realurl.

I'll consider it :) Thanks for the idea.

from typo3-realurl.

Obviously one cannot send pull requests for the wiki. If the documentation would live in the main git repository, one could contribute using pull requests.

from typo3-realurl.

There is not usable offline editor for REST files. That's the only reason, which stops me from making docs inside the extension. I am not willing to learn REST syntax and write docs manually. I could spend time in a better way.

from typo3-realurl.