Hyperlinks Unintuitive in Readme #2

New Issue

Zekkos · 2025-09-02T17:06:54-07:00

Zekkos commented

2025-09-02 17:06:54 -07:00

The sentance "Next we will implement the methods which in this case will be an interface" has hyperlinks on the words "methods" and "interface". The "methods" hyperlink links to a line in the code and the "interface" hyperlink links to an external website.

I feel like there should be some sort of indication what something will link to. A good example of this come from the next line "and finally we will implement the struct to hold the actual state of the device. (note there is some funkiness in c with implementing this since you will need forward decls)" where "struct to hold the actual state" is a hyperlink to code. It is directly referencing something in the code.

The difference between "methods" and "struct to hold the actual state" is one is referencing the concept the lines of code represent while the other is referencing the actual implementation of a concept.

This is probably something that should be held to consistently throughout the entire readme.
I would go as far to say also doing something for internal links to somewhere else in the read me, like when "inputs" is being referenced. Instead of hyprlinking the word "inputs" it might be worth hyprlinking a phrase like "the inputs we previously defined".

The sentance "Next we will implement the methods which in this case will be an interface" has hyperlinks on the words "methods" and "interface". The "methods" hyperlink links to a line in the code and the "interface" hyperlink links to an external website. I feel like there should be some sort of indication what something will link to. A good example of this come from the next line "and finally we will implement the struct to hold the actual state of the device. (note there is some funkiness in c with implementing this since you will need forward decls)" where "struct to hold the actual state" is a hyperlink to code. It is directly referencing something in the code. The difference between "methods" and "struct to hold the actual state" is one is referencing the concept the lines of code represent while the other is referencing the actual implementation of a concept. This is probably something that should be held to consistently throughout the entire readme. I would go as far to say also doing something for internal links to somewhere else in the read me, like when "inputs" is being referenced. Instead of hyprlinking the word "inputs" it might be worth hyprlinking a phrase like "the inputs we previously defined".

sirlilpanda referenced this issue from a commit

2025-09-06 21:08:21 -07:00

this should now fix #2 some sentances have been reworded so the links to the code make more sense

sirlilpanda referenced this issue

2025-09-06 21:12:12 -07:00

making-readme-more-tutorial-like #6

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: sirlilpanda/c_state_pattern#2