gitea-pages/doc_commenting_on_files.md
2015-09-18 14:25:02 -07:00

1.1 KiB

title, tags, keywords, last_updated, summary, published
title tags keywords last_updated summary published
Commenting on files
navigation
annotations, comments, feedback August 12, 2015 You can add a button to your pages that allows people to add comments. Prose.io is an overlay on Github that would allow people to make comments in an easier interface. true

About the review process

If you're using the doc as code approach, you should also consider using the same techniques for reviewing the doc as people use in reviewing code. This approach will involve using Prose.io as an interface. Users will have Github accounts and authorize Prose.io to access their Github.

There's an Edit me button on each page on this theme. This button allows collaborators to edit the content on Github.

Add the edit button to your pages

Instruct reviewers to authorize Prose.io

People who plan to review the project need to authorize Prose.io on their computers.

<img src="{{ "/images/authorizeongithub.png" | prepend: site.baseurl }}" alt="Authorize Prose.io" />

<img src="{{ "/images/authorizegithubscreen2.png" | prepend: site.baseurl }}" alt="Authorze Prose.io on screen 2" />