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

Final documentation update #75

Merged
merged 6 commits into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 20 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,35 +19,37 @@ This repository is a Feed Amalgamator for various Fediverse platforms, in order

```mermaid
graph TD
subgraph Fetchers
LF[LemmyFetcher] -->|Fetches posts| LPB[LemmyPostBuilder]
MF[MastodonFetcher] -->|Fetches posts| MPB[MastodonPostBuilder]
OF[Other Fetchers] -->|Fetches posts| OPB[Other PostBuilders]
subgraph Instances
L1[LemmyInstance1] -->|API Response| LF[LemmyFetcher]
L2[LemmyInstance2] -->|API Response| LF
L3[LemmyInstance3] -->|API Response| LF

M1[LemmyInstance1] -->|API Response| MF[MastodonFetcher]
M2[LemmyInstance2] -->|API Response| MF
M3[LemmyInstance3] -->|API Response| MF

O1[OtherInstances] -->|API Response| OF[Other Fetchers]
end

subgraph PostBuilders
LPB -->|Builds post elements| PF[PostFactory]
MPB -->|Builds post elements| PF
OPB -->|Builds post elements| PF
subgraph Fetchers
LF -->|Fetched posts| LPB[LemmyPostBuilder]
MF -->|Fetched posts| MPB[MastodonPostBuilder]
OF -->|Fetched posts| OPB[Other PostBuilders]
end

subgraph Factory
PF -->|Creates fetchers and post builders| P[Paginator]
subgraph PostBuilders
LPB -->|Builds post elements| P[Paginator]
MPB -->|Builds post elements| P
OPB -->|Builds post elements| P
end

subgraph Paginator
P -->|Manages pagination| IJS[index.js]
end

subgraph Application Initialization
IJS -->|Initializes application| ST[styles/index.css]
subgraph Application
IJS -->|Initializes application| ST[index.html]
end

style Fetchers fill:#f9f,stroke:#333,stroke-width:2px
style PostBuilders fill:#ccf,stroke:#333,stroke-width:2px
style Factory fill:#cfc,stroke:#333,stroke-width:2px
style Paginator fill:#fcf,stroke:#333,stroke-width:2px
style Application Initialization fill:#cff,stroke:#333,stroke-width:2px
```

# Repository Structure
Expand Down
4 changes: 2 additions & 2 deletions admin/ADRs/branching strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
We did not end up originally deciding on a branching style early in the project, but our working style within the team lended itself to the feature branching strategy. We tended to work on particular features in bursts of work, not consistently each day, which lead us to make branches for each feature. We decided to formalize this strategy after our second sprint retrospective.

## Links/References
[Second sprint retrospective](../meetings/2023-12-4.md#sprint-retrospective)
[Second sprint retrospective](../meetings/2023-12-04.md#sprint-retrospective)
## Date: 2023-12-04
The date the decision was made.
(ISO 8601 date format)
(ISO 8601 date format)
3 changes: 2 additions & 1 deletion admin/ADRs/code linting.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ We have decided to adopt ESLint as our primary tool for linting our JavaScript c
## Links/References
- [ESLint Official Website](https://eslint.org/)
- [ESLint Configuration Guide](https://eslint.org/docs/user-guide/configuring)
- [Meeting Notes November 18](admin/meetings/2023-11-18.md)

## Date: YYYY-MM-DD
## Date: 2023-11-18
The date the decision was made.
(ISO 8601 date format)
3 changes: 2 additions & 1 deletion admin/ADRs/custom elements for posts.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ Decided to implement custom elements for posts within our web application. Custo
## Links/References
- [Web Components Introduction](https://developer.mozilla.org/en-US/docs/Web/Web_Components)
- [Using Custom Elements](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements)
- [Meeting Notes for Nov 29](admin/meetings/2023-11-29.md)

## Date: YYYY-MM-DD
## Date: 2023-11-29
The date the decision was made.
(ISO 8601 date format)
3 changes: 2 additions & 1 deletion admin/ADRs/project deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ Decided to use Netlify as our deployment platform for the main project.
## Links/References
- [Netlify Documentation](https://docs.netlify.com)
- [Netlify Pricing](https://www.netlify.com/pricing/)
- [Meeting Notes for November 29](admin/meetings/2023-11-29.md)

## Date: YYYY-MM-DD
## Date: 2023-11-29
The date the decision was made.
(ISO 8601 date format)

2 changes: 1 addition & 1 deletion admin/ADRs/testing framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@ Team decided to adopt Node.js native testing tools, for implementing our unit te
## Links/References
- Node.js `assert` module documentation: [https://nodejs.org/api/assert.html](https://nodejs.org/api/assert.html)

## Date: YYYY-MM-DD
## Date: 2023-11-11
The date the decision was made.
(ISO 8601 date format)
Loading