documentation

[larshp]

Suggest placing somewhere under http://docs.abapgit.org

[absap]

I think we should provide some documentation guides

• Development Setup Guide (see #18)
• FAQ

Where should these guides reside? Ideas:

• Project Wiki?
• Separate .md files in the project root and linked into README?

[larshp]

in abapGit and abapOpenChecks github-pages are used, via static pages compiled using jekyll.

The github wiki has the disadvantage that it is not possible to submit pull requests for it

First I guess we need to decide what is the nicest url for accessing docs, eg: http://eclipse.abapgit.org (this is the same as suggested for the update site, not sure if they can live together) http://eclipse.abapgit.org/docs http://docs.abapgit.org/eclipse <- I like this one

Information for abapGit development I have collected at http://docs.abapgit.org/development/, so perhaps just a page here can contain the Development Setup Guide?

[absap]

As more and more dev topics come together, I would suggest that we start very soon with a developer documentation. For the beginning, a .md file linked in README.md could do the job.

[larshp]

agree, .md is good for now

[absap]

I'm going to create one

[absap]

any suggestions for naming the document? dev-guidelines.md

I already prepared a feature branch for it.

[larshp]

dev-guidelines.md is good 👍