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

Arranger Dev Documentation Update #892

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

Conversation

MitchellShiell
Copy link
Contributor

@MitchellShiell MitchellShiell commented Sep 23, 2024

Easiest to read from the docs site here. File names will match closely to the URL structure

  • An updated Readme.md file.
  • An updated contributing file
  • An updated code_of_conduct file
  • An updated license.md file
  • A /docs folder with the following structure:
.
├── overview.md
├── setup.md
└── usage/
    ├── usage.mdx
    ├── 01-index-mappings.md
    ├── 02-arrranger-components.md
    └── 03-sqon-filter-notation.md
  • Overview
  • Setup
  • Index Mappings
  • Arranger Configs
  • SQON Filter Notation (actionable: needs info on justification of SQONs)

Important

Before going live will need to update any links to the demo discussion board and Netlify deploy preview

Notes for reviewers

  • All arranger docs are read for review all links the /mitchellshiell/bridge/ (particularly in the contributing file)will be updated before merging

Copy link
Member

@justincorrigible justincorrigible left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's my ¢2

docs/05-Arranger.md Outdated Show resolved Hide resolved
docs/05-Arranger.md Outdated Show resolved Hide resolved
docs/05-Arranger.md Outdated Show resolved Hide resolved
docs/05-Arranger.md Outdated Show resolved Hide resolved
docs/05-Arranger.md Outdated Show resolved Hide resolved
docs/05-Arranger.md Outdated Show resolved Hide resolved
@MitchellShiell MitchellShiell changed the title [WIP] - Arranger Dev Docs Update [WIP] - Arranger Dev Documentation Sep 27, 2024
@MitchellShiell MitchellShiell marked this pull request as ready for review October 29, 2024 14:09
MitchellShiell and others added 24 commits November 2, 2024 19:06
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Co-authored-by: Anders Richardsson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Help docs are needed for this/writing docs needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants