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

docs: add support guidelines #40

Merged
merged 14 commits into from
Mar 11, 2022
Merged

docs: add support guidelines #40

merged 14 commits into from
Mar 11, 2022

Commits on Mar 9, 2022

  1. Adding first pass at support guidelines. 

    Rename and move documentation pages for clarity

[!808] Move index files for design docs and expand into README files

[!821] Fix numerours code highlighting and markup issues, add TOCs

- TOC still missing on design docs

[!835] Add AVP instructions to docs

Other improvements of the docs include

- table-of-contents generation fixed
- replace links to external markdown files with HTML. Not sure why doxygen doesn't complain in CI, it failed with version 1.8.13 in my ADE
- spell checking of numerous documents
- remove subtree doc
    @kenji-miyake
    Joshua Whitley authored and kenji-miyake committed Mar 9, 2022
    Configuration menu
    Copy the full SHA
    e4d71b2 View commit details
    Browse the repository at this point in the history

  2. update documents 

    Signed-off-by: Kenji Miyake <[email protected]>
    @KeisukeShima @kenji-miyake
    KeisukeShima authored and kenji-miyake committed Mar 9, 2022
    Configuration menu
    Copy the full SHA
    ed0d5d0 View commit details
    Browse the repository at this point in the history

  3. update documents 

    Signed-off-by: Kenji Miyake <[email protected]>
    @kenji-miyake
    Kenji Miyake authored and kenji-miyake committed Mar 9, 2022
    Configuration menu
    Copy the full SHA
    b503777 View commit details
    Browse the repository at this point in the history

  4. change link 

    Signed-off-by: Kenji Miyake <[email protected]>
    @kenji-miyake
    Kenji Miyake authored and kenji-miyake committed Mar 9, 2022
    Configuration menu
    Copy the full SHA
    ae7fe87 View commit details
    Browse the repository at this point in the history

  5. Update docs/help/support-guidelines.md 

    Co-authored-by: M. Fatih Cırıt <[email protected]>
    @kenji-miyake @xmfcx
    kenji-miyake and xmfcx authored Mar 9, 2022
    Configuration menu
    Copy the full SHA
    c989428 View commit details
    Browse the repository at this point in the history

  6. Update docs/help/support-guidelines.md 

    Co-authored-by: M. Fatih Cırıt <[email protected]>
    @kenji-miyake @xmfcx
    kenji-miyake and xmfcx authored Mar 9, 2022
    Configuration menu
    Copy the full SHA
    6dc8e27 View commit details
    Browse the repository at this point in the history

  7. Update docs/help/support-guidelines.md 

    Co-authored-by: M. Fatih Cırıt <[email protected]>
    @kenji-miyake @xmfcx
    kenji-miyake and xmfcx authored Mar 9, 2022
    Configuration menu
    Copy the full SHA
    29ad306 View commit details
    Browse the repository at this point in the history

  8. Update docs/help/support-guidelines.md 

    Co-authored-by: M. Fatih Cırıt <[email protected]>
    @kenji-miyake @xmfcx
    kenji-miyake and xmfcx authored Mar 9, 2022
    Configuration menu
    Copy the full SHA
    a9f5035 View commit details
    Browse the repository at this point in the history

  9. Update docs/help/support-guidelines.md 

    Co-authored-by: M. Fatih Cırıt <[email protected]>
    @kenji-miyake @xmfcx
    kenji-miyake and xmfcx authored Mar 9, 2022
    Configuration menu
    Copy the full SHA
    413852c View commit details
    Browse the repository at this point in the history

  10. Update docs/help/support-guidelines.md 

    Co-authored-by: M. Fatih Cırıt <[email protected]>
    @kenji-miyake @xmfcx
    kenji-miyake and xmfcx authored Mar 9, 2022
    Configuration menu
    Copy the full SHA
    f649d65 View commit details
    Browse the repository at this point in the history

Commits on Mar 10, 2022

  1. apply review 

    Signed-off-by: Kenji Miyake <[email protected]>
    Kenji Miyake committed Mar 10, 2022
    Configuration menu
    Copy the full SHA
    5fcad54 View commit details
    Browse the repository at this point in the history

Commits on Mar 11, 2022

  1. Update docs/help/support-guidelines.md 

    Co-authored-by: M. Fatih Cırıt <[email protected]>
    @kenji-miyake @xmfcx
    kenji-miyake and xmfcx authored Mar 11, 2022
    Configuration menu
    Copy the full SHA
    30a665f View commit details
    Browse the repository at this point in the history

  2. Update docs/help/support-guidelines.md 

    Co-authored-by: M. Fatih Cırıt <[email protected]>
    @kenji-miyake @xmfcx
    kenji-miyake and xmfcx authored Mar 11, 2022
    Configuration menu
    Copy the full SHA
    3881176 View commit details
    Browse the repository at this point in the history

  3. Update docs/help/support-guidelines.md 

    Co-authored-by: M. Fatih Cırıt <[email protected]>
    @kenji-miyake @xmfcx
    kenji-miyake and xmfcx authored Mar 11, 2022
    Configuration menu
    Copy the full SHA
    c9ad98c View commit details
    Browse the repository at this point in the history