Scribe-Data
Scribe-Data copied to clipboard
scribe-org
Update docs with file types and directory indicators
Terms
- [X] I have searched open and closed feature requests
- [X] I agree to follow Scribe-Data's Code of Conduct
Description
As discussed in Saturday's sync, it would be good to have a more explicit definition of the paths within the documentation. If we are going to the documentation of a file, then it would be great to have the filetype appended to the end of the navigation, and if we're going to a directory, then it'd be great if the navigation had a / at the end :)
This issue would apply this throughout the docs. I'll send along two examples of each of the above. The way that it can be tested locally is to cd into the docs directory and then do make html, which is a command from sphinx. From there, within build/html we can use live server to open index.html by right clicking it (see below):
From there the local version of the docs will be opened in the default browser such that progress can be checked 😊
Contribution
@lillian-mo indicated that this issue would be of interest 😊 Feel free to write in here and I'll assign!
@lillian-mo, 06d109a includes the two base examples that I did in the sync, which I confirmed as working locally. Let me know if there's anything else I can do to support!
Hey @lillian-mo 👋 Feel free to write in here so I can assign :) Also, I'll be doing the directory refactor today after all as I work through the current PR, but that should be done by EOD. I'll write in here when it's all done!
All the directory reordering has gone through now, so we're good to go for this! :)
Hey @lillian-mo 👋 Quick checkin on this :) Let me know if a call would help here! No stress if you're a bit busy 😊
Hey! I’m super sorry for the delay, I can probably get this done bu the end of next week. It’s currently midterm season so I’ve been falling behind a lot. Super sorry again!
On Sun, Jun 23, 2024 at 3:47 PM Andrew Tavis McAllister < @.***> wrote:
Hey @lillian-mo https://github.com/lillian-mo 👋 Quick checkin on this :) Let me know if a call would help here! No stress if you're a bit busy 😊
— Reply to this email directly, view it on GitHub https://github.com/scribe-org/Scribe-Data/issues/135#issuecomment-2185286029, or unsubscribe https://github.com/notifications/unsubscribe-auth/AR5RVDJ72OKO3ZCD44W5LA3ZI4Q4HAVCNFSM6AAAAABIAIX64CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCOBVGI4DMMBSHE . You are receiving this because you were mentioned.Message ID: @.***>
No stress at all, @lillian-mo! Just checking in :) If it's midterms, then wait till they're done! And good luck! 🍀
hey @andrewtavis super sorry about the delay! I should be able to get to this this weekend - I'll let you know if I need any help!
@andrewtavis thanks! I've changed some of the links, but I can't seem to push these changes as the html isn't part of the directory - how should I do that?
Hey @lillian-mo! 👋 The changes should be going into the docs subdirectory here and then your changes would be reflected in there. So basically the .rst files, and then you can test it with the make html command from within the docs directory :) Hope this helps, and let me know if you'd like to chat about it!
@andrewtavis super sorry for missing this! (also sorry for being super slow in general) Sounds good, will fix soon!
No stress at all, @lillian-mo! Take your time, and thanks for the communication here!
In progress via a recent discussion between @lillian-mo and I :) Let me know if any help's needed!