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

Add Booting Docs #26

Merged
merged 19 commits into from
Apr 24, 2023
Merged

Add Booting Docs #26

merged 19 commits into from
Apr 24, 2023

Conversation

Sploder12
Copy link
Member

Description

Adds documentation about the booting process

Issue #13

Type of change

  • Documentation

Testing

Github's .md renderer likes it.

Checklist:

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings

@emilkovacev
Copy link
Member

Would diagrams be out of the question? Not a must-have, but definitely useful for visualizing memory locations and how much memory each section has. We can then adopt additional diagrams when we get to allocating memory in more complex ways!

Copy link
Member

@emilkovacev emilkovacev left a comment

Choose a reason for hiding this comment

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

Just a couple of small things, maybe something to keep in mind if we want to standardize docs in the future.

docs/boot/boot.md Outdated Show resolved Hide resolved
docs/boot/boot.md Outdated Show resolved Hide resolved
docs/boot/boot.md Show resolved Hide resolved
docs/boot/boot.md Show resolved Hide resolved
Copy link
Member

@emilkovacev emilkovacev left a comment

Choose a reason for hiding this comment

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

I added a few small suggestions.

For some reason it seems like single \n characters are rendering in markdown (when I thought only \n\n would), stylistically I think it's easier to read as singular paragraphs.

Also, some standards suggestions:

  • Registers like l0 should be put in backticks
  • When referring to the size in bits or bytes, we should use the format: num-bytes or num-bits: Ex: 32-bit x86 linux

docs/boot/boot.md Outdated Show resolved Hide resolved
docs/boot/boot.md Outdated Show resolved Hide resolved
docs/boot/boot.md Outdated Show resolved Hide resolved
docs/boot/boot.md Outdated Show resolved Hide resolved
docs/boot/boot.md Outdated Show resolved Hide resolved
docs/boot/boot.md Outdated Show resolved Hide resolved
docs/boot/boot.md Outdated Show resolved Hide resolved
docs/boot/boot.md Outdated Show resolved Hide resolved
docs/boot/boot.md Outdated Show resolved Hide resolved
Sploder12 and others added 9 commits April 23, 2023 12:42
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
Co-authored-by: Emil Kovacev <[email protected]>
@Sploder12
Copy link
Member Author

For some reason it seems like single \n characters are rendering in markdown (when I thought only \n\n would), stylistically I think it's easier to read as singular paragraphs.

\ns are not being rendered! But s are! (I really don't know why markdown decided two spaces was a good way to signify new line)

@emilkovacev
Copy link
Member

Ah ok, that makes slightly more sense. I think we should remove those double spaces so it's formatted in paragraphs.

Copy link
Member

@emilkovacev emilkovacev left a comment

Choose a reason for hiding this comment

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

Good stuff! I think this is ready for merging.

@Sploder12 Sploder12 merged commit c61f2bc into makeopensource:main Apr 24, 2023
@Sploder12 Sploder12 deleted the Boot-Docs branch April 24, 2023 16:16
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.

2 participants