Add documentation for Lyrics #504
Conversation
|
@sonny-mo Very nice idea. Looks like @snshn will review this later. One problem I have is that when I go to https://contour.so there's not really any information about the project itself (i.e. owner, source code). And when I click "Get Started", I get this page:
I don't think you're trying to do anything sneaky, just giving you my first impressions. It seems like an interesting project. Adding navigation links based on how it's laid out in the wiki, for example. What happens when the lyrics wiki gets updated? Would https://docs.contour.so/Lyrics/lyrics/manual-3w93hpzablu000000000 be updated automatically? Who is hosting the server and how long has it been operational? I'm not the maintainer of this project, just a new contributor sharing some thoughts. ;) |
|
@andy5995 Thanks for this feedback! A landing page should be up some time today! I was focusing mostly on creating the best documentation experience possible for this repo so didn't have the time :) Also, changed permissions so that it doesn't ask for email addresses. Regarding what happens to when the lyrics wiki, for now you'd have to manually edit on the platform (It's a super pleasant experience with the WYSIWYG markdown). I'll add an export feature (all the docs displayed are Markdown) so that maintaining is super easy. I'm hosting the server and it's been up for 4 months with regular backups. It'll run until at least 2023 and in case anything comes up, I'll export what's on the platform into the lyrics wiki! |
|
The main problem that I see is that the documentation is built as a web app, rather than a website, hence won't work without JS and can't be easily saved to disk or crawled by web crawlers that don't support JS. On a side note, the anchors don't seem to work when I click on H1/H2/H3/H4, even though the pound sign is being shown. |
|
Hmm you bring up some great points. I've fixed the issue with the anchor links: an example here. In terms of saving on disk, the web app actually is just serving markdown files, so I'll have an export option made available. The problem with web crawlers and using JS sounds important: I'll have SSR going soon to help with this. Hopefully this is helpful? |
Hi,
I thought it might be helpful to have the Wiki migrated so and deployed so that it looks more visible to future contributors. In addition to this, I generated some reference docs that I'm not sure how helpful they are.
Regardless, feel free to check out the docs here and hope it helps!