-
Notifications
You must be signed in to change notification settings - Fork 3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Import wiki to docs #2734
Conversation
- added imports to TOC - deleted Home.rst - removed spurious html formatting `li`, `h4` etc - fixed H1s Still to do - rename files - actually look at content :-p
A good start, but needs some work.
Same with installation issues (but it needs to be merged nicely with the current installation page somehow) Articles need to be checked that they still exist (remove the oldest ones) and added as an entry in the discussion forum. It can still be a page in the docs, but maybe just a few titles and a link to that entry. I prefer not having to maintain the list myself.
|
@cyberw this is probably at the good enough stage, what do you think? |
A few things:
And some of the titles (the ones that are error messages) should be formatted as code, and not as headers. It looks a bit weird atm:
|
There's an extra "the" here:
Probably turning the sentence around to start with "having trouble generating enough load" fits better with the title of the page, but perhaps the title could be reworked as well? |
Other than that, great stuff! |
I should have said, I'm trying to do the minimum viable import so we can merge this, so I'm concentrating more on importing the wiki as is rather than making sure all of the imported docs are in tip top shape, then we can iterate over it as part of the overhaul. The code/title heading is in that psutil thing is gonna look weird either way unless we reword it.
|
oh, and formatting the "FAQ" page is not top prio (if it should even exist at all, I'd prefer moving the entries there to other places). What does need to be fixed is the explicit reference to the wiki :) (you can just remove this paragraph)
|
Agreed - migrating FAQ to other places usually makes more sense. But to do that properly I've have to take a proper look at the contents. :-D |
Looks good now! I'll squash the commits, unless you want a plain merge? |
Whatever your normal is! Squashed is fine with me.
…On Fri, 7 Jun 2024, 11:44 Lars Holmberg, ***@***.***> wrote:
Looks good now! I'll squash the commits, unless you want a plain merge?
—
Reply to this email directly, view it on GitHub
<#2734 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAXNASFSX3QE3UF3RZQAJ3ZGF6H7AVCNFSM6AAAAABIJVCDB6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNJUGQ4DGNRVHA>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
Btw, there's an open PR for changing the build/install process (#2725) so don't for some reason go off spending time documenting the current install procedure :) |
li
,h4
etcNot done