smol-rs
Add an ARCHITECTURE.md document
It would be useful to have an ARCHITECTURE document that can be used by new contributors to get a "bird's eye view" of how things are arranged in smol. This commit adds a basic ARCHITECTURE.md document with the aim that it can be used by prospective contributors.
So far only the lower-level items of the ecosystem have been described.
BTW, instead of putting all this in a separate doc, I think it should just be here. We'll need a new repo named smol-rs.
BTW, instead of putting all this in a separate doc, I think it should just be here. We'll need a new repo named
smol-rs.
Do you mean the .github repository? It's probably a long document for the frontpage.
BTW, instead of putting all this in a separate doc, I think it should just be here. We'll need a new repo named
smol-rs.Do you mean the
.githubrepository?
AFAIK, you need to create a repository by the same name as the space (smol-rs in this case) to show the README.md from it on the front page.
It's probably a long document for the frontpage.
People don't need to read all of it. I think visibility and discoverability is more important. Having said that, I wouldn't mind a different document on the front page but until someone write that, I think this should go there.
People don't need to read all of it. I think visibility and discoverability is more important. Having said that, I wouldn't mind a different document on the front page but until someone write that, I think this should go there.
I've put an interim document on the frontpage for now.