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.

Sign up for GitHub

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

Jump to bottom

How to document cnd's HTTP API #38

Merged
merged 20 commits into from
Sep 3, 2019
Merged

How to document cnd's HTTP API #38

merged 20 commits into from
Sep 3, 2019

Commits on Aug 27, 2019

  1. Start filling in the template

    @luckysori
    luckysori committed Aug 27, 2019
    Configuration menu
    Copy the full SHA
    90cdb10 View commit details
    Browse the repository at this point in the history

Commits on Aug 29, 2019

  1. Do the spike

    @luckysori
    luckysori committed Aug 29, 2019
    Configuration menu
    Copy the full SHA
    aee9bc4 View commit details
    Browse the repository at this point in the history

  2. Add entry to README.md

    @luckysori
    luckysori committed Aug 29, 2019
    Configuration menu
    Copy the full SHA
    aaca50f View commit details
    Browse the repository at this point in the history

Commits on Sep 3, 2019

  1. Fix internal links

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    32aa452 View commit details
    Browse the repository at this point in the history

  2. Follow one-line-per-sentence policy

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    e0b4366 View commit details
    Browse the repository at this point in the history

  3. Fix some periods

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    16e4698 View commit details
    Browse the repository at this point in the history

  4. Remove duplicated section

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    a227572 View commit details
    Browse the repository at this point in the history

  5. Use more whitespace

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    3c4914f View commit details
    Browse the repository at this point in the history

  6. Fix image links

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    dfdc433 View commit details
    Browse the repository at this point in the history

  7. Actually fix image links

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    a32cad3 View commit details
    Browse the repository at this point in the history

  8. Embrace manual documentation to take control

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    505f80f View commit details
    Browse the repository at this point in the history

  9. Mention ReDoc custom section support

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    e4dfc7f View commit details
    Browse the repository at this point in the history

  10. Improve specification generation recommendations

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    f5f117b View commit details
    Browse the repository at this point in the history

  11. Mention code reuse via $ref

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    7419c39 View commit details
    Browse the repository at this point in the history

  12. Improve extension link relation type section

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    ed0d1dd View commit details
    Browse the repository at this point in the history

  13. Summarise recommendations at the end

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    ed6719b View commit details
    Browse the repository at this point in the history

  14. Enhance section on elements of the documentation

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    e23ed62 View commit details
    Browse the repository at this point in the history

  15. Suggest rather than recommend endpoint name

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    9e2903b View commit details
    Browse the repository at this point in the history

  16. Use spike number 16 since 15 was taken

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    1e0e1ab View commit details
    Browse the repository at this point in the history

  17. Merge branch 'master' into 1122-document-cnd-http-api

    @luckysori
    luckysori committed Sep 3, 2019
    Configuration menu
    Copy the full SHA
    b3dfb80 View commit details
    Browse the repository at this point in the history