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

Add docfx and documentation style guide #103

Open
wants to merge 31 commits into
base: main
Choose a base branch
from
Open

Add docfx and documentation style guide #103

wants to merge 31 commits into from

Commits on Sep 9, 2024

  1. initial draft of updated readme

    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    8db2115 View commit details
    Browse the repository at this point in the history

  2. updated formatting

    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    d7b527d View commit details
    Browse the repository at this point in the history

  3. updated readme with how to setup a new docfx website

    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    1ea57b0 View commit details
    Browse the repository at this point in the history

  4. edited code blocks

    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    7c18b4f View commit details
    Browse the repository at this point in the history

  5. added section on adding markdown tables, mermaid graphs, and publishi… 

    …ng to Github Pages,
    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    d835e6e View commit details
    Browse the repository at this point in the history

  6. added section on testing unpublished packages and other edits to cont… 

    …ents
    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    092f1e0 View commit details
    Browse the repository at this point in the history

  7. minor formatting edits to fix examples not showing

    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    5bd73f6 View commit details
    Browse the repository at this point in the history

  8. added docs and TOC organization section, alerts section

    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    2521838 View commit details
    Browse the repository at this point in the history

  9. added individual operator articles (apidoc)

    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    6ffb7ef View commit details
    Browse the repository at this point in the history

  10. Expanded docfx.json configuration options, edits to enhance imperativ… 

    …e style and grammar
    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    a0fd365 View commit details
    Browse the repository at this point in the history

  11. reorganised sections, added instructions on amending config.yml to ad… 

    …d missing packages for SVG export
    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    4825f06 View commit details
    Browse the repository at this point in the history

  12. added tutorial submodule section and other minor formatting/grammar e… 

    …dits
    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    921ff9e View commit details
    Browse the repository at this point in the history

  13. minor formatting and spelling corrections

    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    bed6dfd View commit details
    Browse the repository at this point in the history

  14. Trim README, move content to new package documentation article

    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    cd821c4 View commit details
    Browse the repository at this point in the history

  15. Add documentation alert to create package article 

    - and minor edit to README clarity
    @banchan86
    banchan86 committed Sep 9, 2024
    Configuration menu
    Copy the full SHA
    049f3b2 View commit details
    Browse the repository at this point in the history

Commits on Sep 10, 2024

  1. Split doc article, update TOC

    @banchan86
    banchan86 committed Sep 10, 2024
    Configuration menu
    Copy the full SHA
    97a4136 View commit details
    Browse the repository at this point in the history

Commits on Sep 11, 2024

  1. Clean up docfx article, add directory trees

    @banchan86
    banchan86 committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    e8cc69a View commit details
    Browse the repository at this point in the history

  2. Minor edits to TOC, and docfx doc article

    @banchan86
    banchan86 committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    70ec67c View commit details
    Browse the repository at this point in the history

Commits on Sep 12, 2024

  1. Expand documentation style article

    @banchan86
    banchan86 committed Sep 12, 2024
    Configuration menu
    Copy the full SHA
    a9eb2c0 View commit details
    Browse the repository at this point in the history

Commits on Sep 16, 2024

  1. Update doc style guide with cross-referencing

    @banchan86
    banchan86 committed Sep 16, 2024
    Configuration menu
    Copy the full SHA
    73cf304 View commit details
    Browse the repository at this point in the history

  2. Fix broken section anchor in docfx doc guide

    @banchan86
    banchan86 committed Sep 16, 2024
    Configuration menu
    Copy the full SHA
    4d13261 View commit details
    Browse the repository at this point in the history

Commits on Sep 19, 2024

  1. Minor edits for clarity and grammar

    @banchan86
    banchan86 committed Sep 19, 2024
    Configuration menu
    Copy the full SHA
    1388d0b View commit details
    Browse the repository at this point in the history

  2. Minor edits to clarity and formatting

    @banchan86
    banchan86 committed Sep 19, 2024
    Configuration menu
    Copy the full SHA
    a846242 View commit details
    Browse the repository at this point in the history

Commits on Sep 21, 2024

  1. Clarify build.ps1 purpose

    @banchan86
    banchan86 committed Sep 21, 2024
    Configuration menu
    Copy the full SHA
    8b28c16 View commit details
    Browse the repository at this point in the history

Commits on Nov 9, 2024

  1. Apply suggestions from code review 

    Co-authored-by: glopesdev <[email protected]>
    @banchan86 @glopesdev
    banchan86 and glopesdev authored Nov 9, 2024
    Configuration menu
    Copy the full SHA
    5bb3b85 View commit details
    Browse the repository at this point in the history

  2. Further edits to spelling and formatting based on code review

    @banchan86
    banchan86 committed Nov 9, 2024
    Configuration menu
    Copy the full SHA
    83c57d4 View commit details
    Browse the repository at this point in the history

  3. Edit README to add contribution section and clarify external links

    @banchan86
    banchan86 committed Nov 9, 2024
    Configuration menu
    Copy the full SHA
    10d4a8e View commit details
    Browse the repository at this point in the history

Commits on Nov 12, 2024

  1. Apply suggestions to change absolute to relative links 

    Co-authored-by: glopesdev <[email protected]>
    @banchan86 @glopesdev
    banchan86 and glopesdev authored Nov 12, 2024
    Configuration menu
    Copy the full SHA
    2567ef1 View commit details
    Browse the repository at this point in the history

  2. Change absolute links to relative links in remaining articles

    @banchan86
    banchan86 committed Nov 12, 2024
    Configuration menu
    Copy the full SHA
    fb42b2c View commit details
    Browse the repository at this point in the history

Commits on Nov 15, 2024

  1. Minor edits to wording clarity and formatting

    @glopesdev
    glopesdev committed Nov 15, 2024
    Configuration menu
    Copy the full SHA
    4457090 View commit details
    Browse the repository at this point in the history

Commits on Nov 27, 2024

  1. Edit wording and embed assets directly in the text

    @glopesdev
    glopesdev committed Nov 27, 2024
    Configuration menu
    Copy the full SHA
    7bc3fe8 View commit details
    Browse the repository at this point in the history