Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #2169

Closed
wants to merge 54 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
5c37d4e
Remove references to define_predicate from docs
chrisroos Nov 25, 2015
788c0a1
Fix broken links in README.md
chrisroos Nov 25, 2015
85ee873
Add documentation about creating a new Smart Answer
chrisroos Nov 25, 2015
3dd7981
Update "next node" section smart-answer-flows.md
chrisroos Nov 25, 2015
f9b689f
Add section about the `Flow` class to smart-answers-flows.md
chrisroos Nov 25, 2015
d67f290
Remove references to PhraseLists from docs
chrisroos Nov 27, 2015
1e8a9df
Add documentation about refactoring
chrisroos Nov 27, 2015
9740b45
Add information about common errors
chrisroos Nov 27, 2015
a78f2da
Add info about developing without the dev VM
chrisroos Nov 27, 2015
59361b8
Add information about Errbit
chrisroos Nov 27, 2015
8b9be79
Remove unnecessary full stop
chrisroos Nov 27, 2015
bafd1f9
Update README to link to Trello
chrisroos Nov 27, 2015
bd544ae
Add information about environments
chrisroos Nov 27, 2015
6bf4526
Update "File structure" section
chrisroos Nov 30, 2015
8fc28a9
Update "Next node rules" section
chrisroos Nov 30, 2015
e79eb63
Move "File structure" to its own document
chrisroos Nov 30, 2015
653b21e
Move "Flow definition" to its own document
chrisroos Nov 30, 2015
ba3f896
Move "Question types" to its own document
chrisroos Nov 30, 2015
105d7f3
Move "Next node rules" to its own document
chrisroos Nov 30, 2015
5470215
Move "Storing data" to its own document
chrisroos Nov 30, 2015
b534d02
Move "Outcome templates" to its own document
chrisroos Nov 30, 2015
21b0878
Remove "Executing tests" section
chrisroos Nov 30, 2015
e21ae1e
Move "Adding regression" tests section
chrisroos Nov 30, 2015
6029955
Move "Testing" section
chrisroos Nov 30, 2015
698921f
Remove smart-answer-flows.md
chrisroos Nov 30, 2015
42ee095
Update docs for Outcome templates
chrisroos Nov 30, 2015
b6d2a66
Add docs about Landing page templates
chrisroos Nov 30, 2015
525c00b
Add docs about Question templates
chrisroos Nov 30, 2015
68b4eb3
Add page about ERB templates
chrisroos Nov 30, 2015
8b34edb
Link to specific template docs
chrisroos Nov 30, 2015
c6bc545
Use correct heading in next-node-rules.md
chrisroos Nov 30, 2015
891d39e
Add "Errors" section to next-node-rules.md
chrisroos Nov 30, 2015
9556654
Consistently use fenced code blocks
chrisroos Nov 30, 2015
4ec19ae
Improve docs about Next node rules
chrisroos Nov 30, 2015
4649d7d
Improve "Storing data" docs
chrisroos Nov 30, 2015
750db02
Add docs about pull requests
chrisroos Nov 30, 2015
a747dac
Add docs about removing regression tests
chrisroos Dec 1, 2015
90454cb
Describe the 3 components of this application
chrisroos Dec 3, 2015
9b2e0b2
Update "Running the application" in README
chrisroos Dec 3, 2015
c4f9163
Fix link in developing-without-vm.md
chrisroos Dec 3, 2015
1abd023
Remove links from "Development" in README
chrisroos Dec 3, 2015
adb1bbb
Re-order links to other docs in README
chrisroos Dec 3, 2015
742f1a7
Expand on differences to Preview environment
chrisroos Dec 3, 2015
4cc755f
Add example URLs of pages rendered as Govspeak
chrisroos Dec 3, 2015
e3cf118
Use bullet points in refactoring.md
chrisroos Dec 3, 2015
8c79dd3
Add point about extracting magic numbers
chrisroos Dec 3, 2015
db52741
Add development-principles.md
chrisroos Dec 3, 2015
c616a90
Set language to ERB where appropriate
chrisroos Dec 3, 2015
d8c6e00
Add information about state variables to erb-templates.md
chrisroos Dec 8, 2015
81dd6dd
Add information about state variables to storing-data.md
chrisroos Dec 8, 2015
7f0c041
Update pull-requests.md
chrisroos Dec 8, 2015
943c994
Explain the lack of ActiveRecord Railtie in README.md
chrisroos Dec 8, 2015
403de0c
Use consistent language in dev VM README links
chrisroos Dec 8, 2015
f8ff663
Update development-principles.md
chrisroos Dec 8, 2015
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix broken links in README.md
chrisroos committed Nov 27, 2015
commit 788c0a1942ef2893256380a0ba82008f3834b7c2
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -32,15 +32,15 @@ This is a Ruby on Rails application that both contains and serves the Smart Answ

**NOTE.** This application doesn't use a database.

Read more about the [structure and syntax of Smart Answers](doc/smart-answers-flows.md).
Read more about the [structure and syntax of Smart Answers](doc/smart-answer-flows.md).

### Dependencies

* [alphagov/static](https://github.com/alphagov/static): provides static assets (JS/CSS) and the GOV.UK templates.

### Running the application

See [development using the GDS development virtual machine](developing-using-vm.md).
See [development using the GDS development virtual machine](doc/developing-using-vm.md).

### Running the test suite