nightscout / trio-docs

GNU Affero General Public License v3.0
8 stars 10 forks source link

Update index.md #29

Closed tmhastings closed 1 week ago

tmhastings commented 1 month ago
MikePlante1 commented 1 month ago

Looks like these links didn't format correctly:

Screenshot 2024-05-09 at 4 42 41 PM

Guessing it's because it's markdown inside of html?

marionbarker commented 1 month ago

The links are not correct, here's an example:

https://github.com/nightscout/Trio-docs/blob/Operate-Folder-Updates/docs/EN/settings/configuration/carbratios.md#insulin-carbohydrate-ratio

You might mean to use dev instead of Operate-Folder-Updates for now, with a plan to migrate to main soon. Or perhaps you plan to start with main and dev at the same version (commit) when you announce for beta testers, in which case, change the links to point to `main.

Either approach works. But please someone needs to check all the links in the entire docs for incorrect links of this type.

MikePlante1 commented 1 month ago

The links are not correct, here's an example:

https://github.com/nightscout/Trio-docs/blob/Operate-Folder-Updates/docs/EN/settings/configuration/carbratios.md#insulin-carbohydrate-ratio

You might mean to use dev instead of Operate-Folder-Updates for now, with a plan to migrate to main soon. Or perhaps you plan to start with main and dev at the same version (commit) when you announce for beta testers, in which case, change the links to point to `main.

Either approach works. But please someone needs to check all the links in the entire docs for incorrect links of this type.

Better solution, I think, would be to make the links relative instead of absolute, that way it doesn't link to a specific branch of docs

tmhastings commented 1 month ago

I corrected them with the last 3 commits using relative links and removing the dropdowns. I checked that it linked to the correct locations. Please verify it does the same for you (@MikePlante1 or @marionbarker) and submit a review.

MikePlante1 commented 1 month ago

@tmhastings Links didn't work for me. You should exclude the /docs/en/ part off. It'll change for different languages anyway, whenever those are added in the future.

I'd also suggest putting the acronym in parenthesis following the full term.

diff
- [Carb Ratio (CR)](settings/configuration/carbratios.md#insulin-carbohydrate-ratio)
- [Insulin Sensitivity Factor (ISF)](settings/configuration/insulinsensitivities.md#insulin-sensitivity-factor)
- [Basal Rate](settings/configuration/basalprofile.md#basal-profile)
tmhastings commented 1 month ago

@tmhastings Links didn't work for me. You should exclude the /docs/en/ part off. It'll change for different languages anyway, whenever those are added in the future.

I'd also suggest putting the acronym in parenthesis following the full term.

diff
- [Carb Ratio (CR)](settings/configuration/carbratios.md#insulin-carbohydrate-ratio)
- [Insulin Sensitivity Factor (ISF)](settings/configuration/insulinsensitivities.md#insulin-sensitivity-factor)
- [Basal Rate](settings/configuration/basalprofile.md#basal-profile)

Done!

tmhastings commented 1 month ago

I also updated the work in progress to reflect the current state of Trio, warn general users against using a beta version, and instruct beta testers on what to do should they locate an error in the documentation. Also added links for quicker referencing.

marionbarker commented 1 month ago

I don't know how sphinx works but every other website does not start a relative link with a slash "/".

For example, looking at the raw version of index.md, I see this:

Information on [Carb Ratio (CR)](/settings/configuration/carbratios.md#insulin-carbohydrate-ratio)

The location of index.md in the folder structure is docs/EN/index.md The location of carbratios.md in the folder structure is docs/EN/settings/configuration/carbratios.md

I would expect the link should be formatted like this:

Information on [Carb Ratio (CR)](settings/configuration/carbratios.md#insulin-carbohydrate-ratio)

or

Information on [Carb Ratio (CR)](../settings/configuration/carbratios.md#insulin-carbohydrate-ratio)
tmhastings commented 1 month ago

Ok. Hopefully they work now? 😁

tmhastings commented 1 month ago

That fixed the links. (I also did a global search and found no more instances of (/relative-path in the *.md files.

I don't know if you want to add a commit to remove Other AIDs <./resources/alternative.md> because you already deleted the file or open a separate PR.

I will include it in this PR and tag for your review of the changes.

Edit: @marionbarker ready for final review after removing orphaned link to alternative.md

tmhastings commented 1 week ago

Replaced with PR #48