Commit Graph

262 Commits

Author SHA1 Message Date
catherineheywood
1df23fff90 Doc tweaks, improve readability (GDS style guide) 2016-05-03 11:36:01 +01:00
catherineheywood
40db98b2c7 Add anchors to titles 2016-05-03 10:28:49 +01:00
catherineheywood
1721139322 Remove image file 2016-05-03 10:23:42 +01:00
catherineheywood
b508596871 change 'two' to '2' (GDS style guide) 2016-04-27 11:16:11 +01:00
catherineheywood
a554d06c1d Improve navigation
Create links from bullet list in API endpoints section down to 'POST' and 'GET' examples.
2016-04-26 10:41:07 +01:00
Chris Hill-Scott
bfd11cde6c Fix alignment in docs
Markdown needs 4 space indent to properly indent inside lists etc
2016-04-26 10:17:00 +01:00
catherineheywood
6dd5b5950b Add line 2016-04-25 15:29:58 +01:00
catherineheywood
8dfc2cbb33 Revert 2016-04-25 15:07:05 +01:00
catherineheywood
be468f16c3 make whole list html 2016-04-25 14:57:47 +01:00
catherineheywood
b5e509cc06 missed <strong> tag 2016-04-25 14:45:45 +01:00
catherineheywood
5010901cce remove lines and change <b> tags to <strong> 2016-04-25 14:44:34 +01:00
catherineheywood
db809556a1 incorporate html in lists for indentation 2016-04-25 14:35:46 +01:00
Pete Herlihy
70381915c8 Removed line breaks in the list items for API documentation 2016-04-25 14:12:10 +01:00
catherineheywood
b3e84f5c82 Doc tweaks 2016-04-25 13:39:31 +01:00
catherineheywood
ca22f504bc Revise trial mode information 2016-04-25 13:30:41 +01:00
catherineheywood
524d373a19 Revise trial mode information 2016-04-25 13:29:11 +01:00
catherineheywood
81c2f81457 Doc tweaks 2016-04-25 13:11:55 +01:00
catherineheywood
f143f767df Doc tweaks 2016-04-25 11:45:39 +01:00
catherineheywood
84c9f4de97 indents 2016-04-25 10:49:47 +01:00
catherineheywood
994736e650 typo correction 2016-04-25 10:22:51 +01:00
catherineheywood
33acb59d20 correct typo 2016-04-25 10:21:39 +01:00
catherineheywood
4144eaaf69 nest lists 2016-04-25 10:20:55 +01:00
catherineheywood
614f0f7fb3 Client libraries in plural throughout 2016-04-25 09:56:22 +01:00
Chris Hill-Scott
27ad1532e4 Make the flow of using templates better
For users who:
- want to send messages from a template
- want to edit templates

For developers:
- who need to get the ID of a template

This commit mainly cleans up the choose template page so there are less
options, and the options that are there are less wordy.

This means:
- moving ‘send yourself a test’ onto the send messages page, and making
  it button
- stripping a lot of stuff out of the ‘send from API’ page, so it’s more
  obvious what the template ID is
2016-04-19 15:31:19 +01:00
Chris Hill-Scott
e89063e285 Move the image so the app can serve it 2016-04-15 12:15:30 +01:00
Chris Hill-Scott
f7c15dfbaf Add some basic typography, tweak the Markdown
This commit adds some basic type sizes, weights and spacing for HTML
elements scoped inside a `.documentation` container.

It also tweaks some of the Markdown so that it renders the same as it
does on Github.
2016-04-15 12:15:30 +01:00
Rebecca Law
1fe5ae0371 This pull request removes the need for the req and pay in the claims JWT.
Use the new version of the notifications-python-client. This version no longer adds the req and pay to the claims of the jwt.

The change is backward compatible so an older client that sends a JWT with the extra claims will pass authentication.
Once all the clients have been updated to not include the extra claims some updates to exclude them from the method signatures will happen as well.

The documentation has been updated to reflect this change.

https://www.pivotaltracker.com/story/show/116971293
2016-04-15 11:04:35 +01:00
catherineheywood
99d5a3afc7 Doc changes
Add links to PHP and Java libraries
Define sent_at
Indicate how to access template IDs
2016-04-14 16:40:30 +01:00
catherineheywood
9197ed0b1a Doc changes
Make it clearer what placeholders are. 
Make it clearer you need to add a template even if using API.
Remove 'empty' sections.
Other minor changes.
2016-04-14 10:57:37 +01:00
catherineheywood
cfe27d1f75 Doc changes 2016-04-14 09:51:46 +01:00
catherineheywood
0d569d7ba5 typo correction 2016-04-13 10:12:50 +01:00
catherineheywood
3a85907c93 adjust JWT tokens title 2016-04-13 10:00:41 +01:00
catherineheywood
51680358a2 Remove question 2016-04-12 16:42:01 +01:00
catherineheywood
f34a81c983 Move link to authentication.py file 2016-04-12 16:37:10 +01:00
catherineheywood
727cb49f23 Doc tweaks 2016-04-12 16:35:10 +01:00
catherineheywood
8e98f3cf43 Information about JWT tokens 2016-04-12 16:29:05 +01:00
catherineheywood
f56ac2b63e Doc tweaks 2016-04-12 13:31:56 +01:00
catherineheywood
0f9174f06e testing links 2016-04-12 13:26:47 +01:00
catherineheywood
fd8f166a18 Doc tweaks 2016-04-12 13:21:14 +01:00
catherineheywood
b2e7a1db05 Doc tweaks 2016-04-12 13:12:30 +01:00
catherineheywood
d11af32f63 Correct alignment in list 2016-04-12 13:09:18 +01:00
catherineheywood
85c996d09a Edit text in image 2016-04-12 10:20:47 +01:00
catherineheywood
a7186b43db Doc tweaks 2016-04-12 10:19:25 +01:00
catherineheywood
faedb3d7be Bring sections over from existing doc, to rework 2016-04-12 09:58:09 +01:00
catherineheywood
eb2ea7ce92 Add link in doc 2016-04-12 09:21:34 +01:00
catherineheywood
42d83ec36f increase text size in image 2016-04-12 09:09:06 +01:00
catherineheywood
b0dc5b5d5f Add section from existing doc, to add more details 2016-04-11 16:27:23 +01:00
catherineheywood
ffe47201a5 Doc tweaks 2016-04-11 16:16:38 +01:00
catherineheywood
565a414ece Added files via upload 2016-04-11 15:58:14 +01:00
catherineheywood
c297c98e66 Rework API section in doc 2016-04-11 15:33:56 +01:00