It's a web-site containing documentation for all aspects of assembly. Follow me and ask yourself a question: "What if assembly had good documentation?"
Sadly, documentation isn't writed yet cuz this site has been created only few days ago (2/18/2023). But we'll work on it! By the way this site weight less than 14 KB excluding docs materials.
So here is a four classic commands for running and building this project.
yarn dev is running development server with hot-reload
yarn start is an alias for yarn dev
yarn build is building out big project to a little bundle
yarn preview is running server to preview builded website
Nice! You want to write documentation or improve website?
Anyway, here is two guides for contributing.
All our pages placed in /src/pages/, directory tree is how url will look like.
I.m. that if you have a file /src/pages/docs/x86/linux/80h.md then url to it will
look like {HOST}/docs/x86/linux/80h. You can use this page for example how to
make MD files. But that isn't enough, you also need to add it to navigation bar.
Here is nothing hard, just go to /src/docs/index.astro file, you will see const
pages that stores all routes and titles in navbar, you should add your page here.
When you performed all actions above you need to post it. To post it you need to
fork our repo and perform a pull request with your changes.
Thanks for your help!
Very well. If you know how to improve website then I think here is no need
to explain how to do that. In short: Fork repo, commit changes and perform
a pull request.
Thanks for your help!
 Bychkov Maxim 💻 🎨 |
 Zaharov Gleb 📝 |
|---|
This project is maintained under MIT License.