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

Consolidate documentation #301

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

ningvin
Copy link
Contributor

@ningvin ningvin commented Feb 3, 2025

The second part of my series of documentation improvements discussed here: #292 / #285.

This PR addresses the following:

  • Converted the tutorial from HTML to Markdown
  • Converted most stuff from the website to Markdown
  • Converted @carenas' overview to Markdown
  • Reworked the overall structure
  • Added some general / setup specific documentation

Copy link
Owner

@zherczeg zherczeg left a comment

Choose a reason for hiding this comment

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

This looks like a large work, thank you. At some point please squash the commits into one.

@@ -0,0 +1,74 @@
<div align="center">
Copy link
Owner

Choose a reason for hiding this comment

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

Can you add html elements to markdown? Is it a standard?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well, sort of. GitHub does (see their GitHub Flavored Markdown spec) and so do pretty much all Markdown flavors that are based on the CommonMark spec (which is most of them).

The usage of HTML here is just for eye candy though, so we could run with plain Markdown just as well

README.md Outdated Show resolved Hide resolved
docs/general/architecture.md Outdated Show resolved Hide resolved
docs/general/architecture.md Outdated Show resolved Hide resolved
## Features

- Supports a variety of [target architectures](#supported-platforms)
- Supports a large number of operations
Copy link
Owner

Choose a reason for hiding this comment

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

This looks like the repeat of readme. When somebody modify one of them, it is easy to forget about the other. Would be good to figure out something for this.

Copy link
Contributor Author

@ningvin ningvin Feb 3, 2025

Choose a reason for hiding this comment

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

Not sure if there is a nice solution for this. I could remove the info from the introduction, but I would definitely keep it in the README as it is the primary entry point for people looking at this project.

docs/tutorial/sources/first_program.c Outdated Show resolved Hide resolved
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