Readme renewal - #216
Conversation
…ed link to features section in TOC
…ok like the same page is linked twice
…ok like the same page is linked twice
|
Looks good! The Claude AI section seems improved now! I've left comments on specific lines with changes. Besides these I'll lay out the further steps:
|
|
Great, thanks @codingfrog27. I'll clean up using the comments you have made. I think it best to go ahead and merge this PR, I'll open a new one for the image + networking related updates so the PRs stay small and organised. |
There was a problem hiding this comment.
Looks good! The Claude AI section seems improved now! I've left comments on specific lines with changes. Besides these I'll lay out the further steps:
- Fix image issue:
- See if we can get mini image to work with sudo in local hosting. If not upload large image
- test online deployment image again
- test and if needed and possible fix mini image dockerfile (but if this would take too much time we leave it be)
- Merge Alpine repo into this one
- Bundle tips into connection tips section
Co-authored-by: Merlin de Cloe <89702955+codingfrog27@users.noreply.github.com>
** this was branched from Merlin's 'readme-restructure' branch, which he will leave a comment about, giving details about the changes he has made.
Original branch changes
(hi Merlin here --v)
This PR and branch was build of off the documentations made prior by me in the branch
readme_restructure. Changes made were:Restructured and organized the different sections around user intent (quick start ->networking etc.) The original readme topics bled into each other, this separation should add clarity.
Reworded and restyled certain sections for added clarity (ie: merging the delay and connection status dot colour bullet points check into 1 concise tip)
Reworked local setup to a cleaner local serving flow.