-
-
Notifications
You must be signed in to change notification settings - Fork 67
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
[WIP] New docs #84
[WIP] New docs #84
Conversation
4988889
to
8cefbea
Compare
45a1359
to
343be21
Compare
An additional thing we need to add to the todo list: theme/package instructions. You've got the API but not instructions on installing/using. |
@McInkay, thanks for checking out! :) At the moment, it's only about themes because there are no packages out there at all, but as soon as https://www.npmjs.com/search?q=keywords%3Athelounge-package has a single package, I'll update the section to be about both themes and packages :) |
I have a number of packages ready to be published once my PRs are merged :-P so yeah, that's fine leaving it as just themes just now, I get that. However, I'm wondering whether that's obvious enough or not. Maybe it is. |
It should be noted in install docs that since Yarn installs into user folder by default, the binary isn't going to be available in $PATH. On linux the fix is to add Yarn global path to your $PATH like EDIT: Actually it is mentioned, but that one liner is probably preferable to be included as well. |
@xPaw, I'd rather not do this because it's very platform-dependent. For example, on macOS (though I know server install is rarely on macOS, but still, we do advertise it as cross-OS :D), it's available by default if you install with Homebrew. You probably remember, but long time ago (ahem) we were documenting how to install Node on Ubuntu, Mac, and Windows, then we had to add CentOS/Fedora/RHEL, at which point we decided to redirect to Node's comprehensive package manager install document (as it is on the current doc). The Yarn install page is actually really good, lets you pick your OS and gives instructions accordingly, so I think I'd rather send reader to this page early in the install section, similarly to what we do with Node. You'd be okay with that? |
You're right their install is pretty good. I just think we can make the npm install section a little easier to follow. For example we don't link to that page on how to install Yarn. |
Yep, that's what I meant, adding a link to this page and making it all a bit better. Will do! |
37c1b7e
to
63d0c28
Compare
63d0c28
to
bc2d536
Compare
1e08bbe
to
8bfc6a3
Compare
8bfc6a3
to
662e631
Compare
662e631
to
aa16a26
Compare
aa16a26
to
369fccb
Compare
369fccb
to
009657d
Compare
_config.yml
Outdated
@@ -6,14 +6,17 @@ include: | |||
- _redirects | |||
kramdown: | |||
toc_levels: "2" | |||
include: | |||
- _redirects |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
dupe
009657d
to
dbb06e4
Compare
56ec8e1
to
56483e5
Compare
56483e5
to
9e52575
Compare
9e52575
to
ef7f3c0
Compare
Closing this PR now. Everything has been moved to other PRs/issues and in most cases merged. Only leftovers of this PR are things that do not need to be merged. |
This is still a work in progress, but keeping it as an open PR as we had people wonder why the docs don't reflect the current state of the project. This will also generate a preview for whoever wants to access them (at your own risk :D).
Definitely not ready for review, so don't waste your time on it yet :)
Closes #42.Extracted to #42Closes #56.Extracted to #134Closes #57.NopeCloses #3.Extracted to #91Closes #24.Extracted to #119Closes #71.Extracted to #116.Closes #83.Extracted to #104TODO
Community page: Backers snippet goes out of the screenAdd a Community page #138Community page: Youtube embed goes out of the pageAdd a Community page #138Configuration page: LongFix ldapFilter overflowing on mobile #151ldapFilter
string is not breaking to the next lineMenu does not mark Guides/API asMoved to Side nav does not mark Guides/API asactive
when visiting one of the guides or the APIsactive
when visiting one of the guides or the APIs #156Won't fix