Closed tmhastings closed 1 week ago
Looks like these links didn't format correctly:
Guessing it's because it's markdown inside of html?
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.
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 ofOperate-Folder-Updates
for now, with a plan to migrate tomain
soon. Or perhaps you plan to start withmain
anddev
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
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.
@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.
- [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 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.
![]()
- [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!
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.
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)
Ok. Hopefully they work now? 😁
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
Replaced with PR #48
Update index.md file to match the overview file previously edited. The detailed explanation under "What is Trio?" was NOT altered as this information should be on the home page. The rest of the information is updated to match what is located elsewhere in the documentation.
links corrected
orphaned file reference removed