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

chore(docs): Add first version of architecture doc #697

Merged
merged 12 commits into from
Dec 18, 2024
Merged

chore(docs): Add first version of architecture doc #697

merged 12 commits into from
Dec 18, 2024

Conversation

adizere
Copy link
Member

@adizere adizere commented Dec 18, 2024

Part of #375


PR author checklist

README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@cason cason left a comment

Choose a reason for hiding this comment

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

Great.

We have some nomenclature problems, as usual, ehe.

There is a reference to a Broadcast effect that I could not find in the referred source file.

ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Show resolved Hide resolved
ARCHITECTURE.md Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Show resolved Hide resolved
ARCHITECTURE.md Show resolved Hide resolved
@cason
Copy link
Contributor

cason commented Dec 18, 2024

I wonder whether this document should go into the docs/ directory.

@cason cason mentioned this pull request Dec 18, 2024
34 tasks
@romac romac changed the title chore(architecture): Added first version chore(dops): Added first version of architecture doc Dec 18, 2024
@romac romac changed the title chore(dops): Added first version of architecture doc chore(dops): Add first version of architecture doc Dec 18, 2024
@adizere
Copy link
Member Author

adizere commented Dec 18, 2024

I wonder whether this document should go into the docs/ directory.

Architecture.md can be seen as a prerequisite to anything that exists in docs/.

@adizere adizere changed the title chore(dops): Add first version of architecture doc chore(docs): Add first version of architecture doc Dec 18, 2024
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
ARCHITECTURE.md Outdated Show resolved Hide resolved
@greg-szabo
Copy link
Member

greg-szabo commented Dec 18, 2024

I've fixed/renamed/updated all outstanding items. The only point I'd like to rehash is where the ARCHITECTURE.md resides. I would still put it in the docs folder because, at one point, we will publish the docs as a website, and if everything is in one place, it makes the process much smoother. (Also, updating documentation is easier if everything is in one place.)

We could leave a placeholder ARCHITECTURE.md in the root folder, pointing to the one in the docs folder.

At least, that's my 2 cents.

@adizere
Copy link
Member Author

adizere commented Dec 18, 2024

I have no particular opinions where architecture.md should sit between top-level and within docs/. Both are fine.

If no one takes a decision/merges by tmrw morning (CET), I'll go ahead and leave as it (at top level) and merge this.

@romac
Copy link
Member

romac commented Dec 18, 2024

Let's put it in docs to not scatter documentation in multiple places. We can always link to it from the readme.

@romac romac closed this Dec 18, 2024
@romac romac reopened this Dec 18, 2024
@romac
Copy link
Member

romac commented Dec 18, 2024

Nevermind, let's leave it where it is, nice to have at the top-level.

@romac romac merged commit 5414259 into main Dec 18, 2024
2 checks passed
@romac romac deleted the adi/arch branch December 18, 2024 22:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants