HackerTrans
TopNewTrendsCommentsPastAskShowJobs

ritinkar

no profile record

Submissions

Show HN: Metadocs, kinda like Reddit, but built into every documentation

metadocs8.com
96 points·by ritinkar·4 lata temu·47 comments

comments

ritinkar
·4 lata temu·discuss
You only need a user account if you want to post a comment or vote on one.

You can browse as guest.

The comments are stored in metadocs servers.
ritinkar
·4 lata temu·discuss
There's a service worker in the background that does quite a bit of the heavy lifting. So, it can't be a pure JS script.
ritinkar
·4 lata temu·discuss
Thanks for the comment. It was quite insightful.

I don't have any prior moderation experience, so I plan on taking up the task myself initially to get a good grasp of the challenge. That way I can build good tools to make the task easier.
ritinkar
·4 lata temu·discuss
So this is not a problem I've solved yet. But I think the solution would involve a mix of community voting and good sorting algorithms.

But I'll only know the correct solution once I start tackling it.
ritinkar
·4 lata temu·discuss
Yup, there most definitely will be. Hoping to do it within the next few months.
ritinkar
·4 lata temu·discuss
Yup. The code was written with portability in mind. As soon as I get time to test it on Firefox I'll do it.
ritinkar
·4 lata temu·discuss
I haven't thought about that direction yet, although I am aware of discourse and disqus.

Metadocs is pretty young, so I'll think about it.
ritinkar
·4 lata temu·discuss
It's hard to articulate the problem like that.

So I was going through a documentation of an ORM library for another project of mine, and it was kinda poorly written. And I didn't feel like going through the effort required to go to another website and ask questions there. I thought I wish I could ask questions right here.

So I took that feeling and turned it into something tangible.
ritinkar
·4 lata temu·discuss
Lots of problems to be solved yet. Moderating 10 comments / day is very different from moderating 10k/day which in turn is different from millions a day.

I'll initially start by moderating comments myself, (need to create a policy first) and see what to do from there.
ritinkar
·4 lata temu·discuss
If you're asking how the "Highlights" feature works, its using something called text fragments.

When the original text changes then the highlight is dead. Meaning you can still discuss it, but it will no longer be highlighted in the window.

You can read more about text fragments here - https://web.dev/text-fragments/
ritinkar
·4 lata temu·discuss
Yeah, cold start and moderation are two problems I need to solve.

I'm focusing on documentation pages at first hoping to build a commpunity that is helpful. Like pointing out pitfalls and better solutions to existing problems.

Also I used to be a stumbleupon user too. I don't remember the discuss feature, but I remember using it to find hidden gems of the web.
ritinkar
·4 lata temu·discuss
Yeah, I need better onboarding. Will fix.
ritinkar
·4 lata temu·discuss
And if you're looking for a quick walkthrough, it's at: https://www.youtube.com/watch?v=oln-KdIczOM