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

Improve README.md #680

Open
vladimir-cucu opened this issue Oct 20, 2023 · 1 comment
Open

Improve README.md #680

vladimir-cucu opened this issue Oct 20, 2023 · 1 comment
Assignees

Comments

@vladimir-cucu
Copy link
Contributor

vladimir-cucu commented Oct 20, 2023

Additional context
After translating the README.md to Romanian language, I've observed a few places in README.md that can be improved. I've listed my proposed improvements bellow.

Describe the solution you'd like to add

  • There are a few chapters that don't have a page to which they should point to. For instance ## [Instructions and Program](Not-Added) would point to 404 -page not found github page. A potential solution might be removing the link entirely and maybe add a TODO e.g. ## Instructions and Program <!-- TODO: Add page and link it here -->.
  • The statement There are three types of conditional statements mainly: in the loops subsection should be There are three types of loops, mainly:.
  • Improve the table with algorithm time and space complexity by making the Time Complexity cell span across 3 columns and the Algorithm cell span across 2 rows. A potential solution might be to use <table> instead with colspan="3" and rowspan="2" for the respective cells.
  • Regarding the same table as above: there are 2 separate tables that can potentially be combined into 1.
  • When describing common time complexities, I think, for consistency reasons, the paragraph with O(n log n) should come before the paragraph with O(n*n).
  • There is a typo in "Here is a simple example of a recursice function in C:". It should be "recursive" instead of "recursive".
  • There is a typo in "... abstractions that are more con- convenient to use than ..." The "con-" should be removed.
  • There are a few multi-line paragraphs in some sections (e.g. Types of Operating Systems) that can be written in a single line in order to make it easier for them to be translated into other languages.
  • Each paragraph in the sub-chapter "Top benefits of cloud computing" could be improved e.g. change "Cost" to "Cost:".
  • Each list item in the sub-chapter "Web Technology" could be improved in a similar fashion as described above.

Edit: additional potential improvents

  • "Networking" and "Internet" chapter name sizes are larger than other chapter name sizes.
  • Code indentation can be improved. Also, for Lisp code syntax highlighting, I think we need to use "cl" instead of "Lisp" as specified here.
@shhossain
Copy link
Owner

@vladimir-cucu you can start to work on it. and your detailed points are very much appreciated.

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

No branches or pull requests

2 participants