Hey guys,
This took a lot of formatting to get my notes from learning C to play nice, hopefully it was worth it. Went for a neon with this one.
Pretty hyped on how it turned out, been working all day on it.
Probably some html validation issues but I will get to these later, time for sleep.
https://williycole.github.io/Technical_Document_Page/
I think this is really cool! You obviously spent a lot of time on this!
I will comment more tomorrow, but I think that you have some small readability issues on mobile that make it hard to read.
1 Like
It’s really great that you wrote your own content instead of grabbing some content off of Wikipedia!
Here are some comments about your content:
-
I see some minor spacing issues on desktop as well:
-
Technically GPU code is written in CUDA or HIP, both of which are very close to C/C++ syntax.
-
Code blocks is an Interactive Development Environment (IDE) that includes C, C++, and Fortran compilers. GCC, Clang, and ICC are examples of C compilers.
-
I would use consistent code formatting in all of your examples, to include indentation. Here is an example:
int main() {
printf("Hello world!\n");
return 0;
}
While I am partial to 1TBS myself, it looks like Girraffe Academy prefers Allman or something along those lines. You can find a list of styles here: https://en.wikipedia.org/wiki/Indentation_style
-
In Data Types, your text says
age = 40but your example hasage = 27. -
In case it wasn’t clear in your lessons,
/* ... */are multi line comment characters and//are inline comment characters. Here is an example:
/*
This is a multi-line
comment
*/
// This is an inline comment
-
In Arrays, your definition of array has pink text for the definition, but you typically use pink text only for the word.
-
You have some minor missing punctuation in a few places.
-
It could be cool to see smart highlighting for keywords like you see on the forum.
I hope these comments are helpful! I am not as skilled with what to look out for with the HTML, so I’ll let others comment on those parts.
1 Like
Lot to look over here, I’ll look over in detail later this afternoon but from the looks of it you are about to save me a ton of time. Yea this is my notes from doing the tutorials, I started to change them up but quickly realize that would have doubled my time.
(hence- In Data Types, your text says age = 40 but your example has age = 27 . and the different indentation at the top, and dumb explanation of comments 
lol)
I tried to get everything to be the same so I could indent properly , add to, change up , and take away unnecessary code today. Some of the comments I gotta take out cause out in the later sections just to take out less clutter. Thankyou so much for the feedback!
[quote=“JeremyLT, post:3, topic:408637”]
- Technically GPU code is written in CUDA or HIP, both of which are very close to C/C++ syntax.
- Code blocks is an Interactive Development Environment (IDE) that includes C, C++, and Fortran compilers. GCC, Clang, and ICC are examples of C compilers.
[/quote] didn’t entirely realize this either so I learned something from your feed back, I think I will include it in my intro section if that’s cool with you?
Thanks again man you killed! I will clean it up later on like I said, would you mind one more look over once I do?
1 Like
I am happy to help; I like seeing some love for C on the forums!
2 Likes
Awesome glad I could put something cool out here. Yea man I love C, that and bash scripting got me in to all this.
One quick note, should be mostly fixed but what do you mean by the smart highlighting?
AH gotcha, Yea I could probably come up with something. may take a bit though.
Man I have never had I pad view give me as much trouble as it is right now with this site. Ipads suuuuk lol