Skip to content

Arranger Dev Documentation Update#892

Merged
justincorrigible merged 55 commits into
unlernafrom
bridgeArranger
Mar 21, 2025
Merged

Arranger Dev Documentation Update#892
justincorrigible merged 55 commits into
unlernafrom
bridgeArranger

Conversation

@MitchellShiell
Copy link
Copy Markdown
Contributor

@MitchellShiell MitchellShiell commented Sep 23, 2024 •
edited
Loading

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

@justincorrigible justincorrigible force-pushed the develop branch 3 times, most recently from 6b33e90 to 7f882d1 Compare September 24, 2024 21:10
justincorrigible
justincorrigible reviewed Sep 26, 2024
View reviewed changes
Copy link
Copy Markdown
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

Comment thread docs/05-Arranger.md Outdated
Comment thread docs/05-Arranger.md Outdated
Comment thread docs/05-Arranger.md Outdated
Comment thread docs/05-Arranger.md Outdated
Comment thread docs/05-Arranger.md Outdated
Comment thread docs/05-Arranger.md Outdated
@MitchellShiell MitchellShiell changed the title [WIP] - Arranger Dev Docs Update [WIP] - Arranger Dev Documentation Sep 27, 2024
@MitchellShiell MitchellShiell mentioned this pull request Oct 6, 2024
Merged
@MitchellShiell MitchellShiell marked this pull request as ready for review October 29, 2024 14:09
MitchellShiell and others added 18 commits November 2, 2024 19:13
@MitchellShiell @justincorrigible
Update docs/overview.md
2426c47 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/setup.md
e4d84d9 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/usage/02-arranger-components.md
f77561b 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/setup.md
8358d68 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/setup.md
fc6cc37 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/usage/01-index-mappings.md
a6f076c 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/setup.md
50cf759 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/setup.md
9b97828 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/usage/01-index-mappings.md
a8fee30 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/usage/01-index-mappings.md
13121da 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/usage/01-index-mappings.md
88b2da7 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/usage/02-arranger-components.md
338d2a9 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell @justincorrigible
Update docs/usage/02-arranger-components.md
a04d904 
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@MitchellShiell
PR updates
23c5ce0
@MitchellShiell
PR updates
66df196
@MitchellShiell
updated bat command
10d4f6a
@MitchellShiell
netlify link
01ef15d
@MitchellShiell
updated cross referenced urls to docs.overture.bio
fa49d36
@MitchellShiell MitchellShiell mentioned this pull request Jan 14, 2025
Closed
8 tasks
@justincorrigible justincorrigible changed the base branch from main to unlerna March 21, 2025 17:13
@justincorrigible justincorrigible merged commit 08227dc into unlerna Mar 21, 2025
@justincorrigible justincorrigible deleted the bridgeArranger branch March 21, 2025 17:14
justincorrigible added a commit that referenced this pull request Mar 21, 2025
@justincorrigible
upgrade to 2025 standards (#923)
87b9c1d 
several changes:
- update node compatibility (v22) and most deprecated dependencies
- enable ESM and update all files to follow that standard
- remove lerna, use npm workspaces
- improve TS, ESLint and Prettier configs
- update testing suites to keep existing coverage
- updates Dev Documentation (#892) thanks to @MitchellShiell
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@justincorrigible justincorrigible justincorrigible approved these changes

Assignees

@justincorrigible justincorrigible

@MitchellShiell MitchellShiell

Labels

documentation Help docs are needed for this/writing docs needed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@MitchellShiell @justincorrigible @joneubank