Update documentation #2169
Closed
Update documentation #2169
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Now that `#define_predicate` no longer exists in the code.
Now that there's only a single way to define next node rules.
Specifically those that you're likely to encounter when developing Smart Answers.
We're no longer using GitHub issues to record the issues/task list.
|
This all looks good to me. 👍 |
This already appears in README.md.
To better explain where the data stored using the four mechanisms can be used.
To link to the instructions for developing with and without the developer VM.
These already appear in "Running the application" so I don't think we need them here too.
I found the "Process" and "Development" sections confusing. I've renamed them to "Smart Answer flow development" and "Smart Answers app development" and moved the documentation links to the relevant section. I find this distinction slightly easier to understand.
As suggested by @floehopper.
The order of these things isn't super important and using bullet points makes it easier to add/remove/re-order points.
Containing some Do's and Dont's of developing Smart Answers.
|
OK, I think I'm done with documentation changes in this branch. Could you take another look when you have a minute please, @floehopper? |
|
Other than my all very minor comments, this looks great to me. |
|
I plan to address the feedback in this PR and get it merged tomorrow. |
Based on feedback from @floehopper.
As suggested by @floehopper.
As suggested by @floehopper.
Based on feedback from @floehopper.
|
I'm happy that I've addressed all the feedback. I'm going to rebase on master locally and then manually merge to master. |
floehopper
added a commit
that referenced
this pull request
Jun 30, 2016
This file was split out of `doc/smart-answer-flows.md` in #2169. However, the references to other sections of that file were not updated. These sections were also split out into their own files in the same pull request. This commit updates the references to link to the other files.
floehopper
added a commit
that referenced
this pull request
Jul 6, 2016
This file was split out of `doc/smart-answer-flows.md` in #2169. However, the references to other sections of that file were not updated. These sections were also split out into their own files in the same pull request. This commit updates the references to link to the other files.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm updating the documentation to help developers new to the project get started. It covers a number of cards in our Smart Answers Tasks Trello board.