[Feature] Document improvement

[guan404ming]

Summary

Improve project documentation across multiple areas including contributor guidelines, technical docs, and documentation website.

Proposed Implementation

• Website content arrangement - Reorganize website documentation under /qumat namespace #818
• Remove outdated document - Remove outdated document #819
• QDP documentation
• Qumat documentation
• Website styling
• PR policy and review guidelines
• Contributing guide (setup, coding standards)
• Committer invitation and nomination process

[ryankert01]

I noticed the documentation framework we’re using is pretty old and doesn’t support modern features like client-side rendering. It might be a good time to explore a more modern framework, which could also help with some of the styling issues we’re seeing.
WDYT? @guan404ming @krishna-dave206 @rawkintrevo

[guan404ming]

I think this makes sense overall 👍
A more modern framework could definitely help with CSR and the styling issues we’re seeing. That said, I agree we should do a bit more investigation first (e.g. evaluate a few candidates, migration cost, risks).

Maybe a good approach is:

• Short term: continue filling out and stabilizing the content.
• In parallel: research and compare modern doc frameworks (features, theming, migration path).
• Then decide on timing and scope for a migration.

[krishna-dave206]

@ryankert01 As we discussed, I'm up for writing documentation for QDP, with that being a frontend guy, I'd also love to style the website. Shall we discuss and start implementing this in this week's meet? Till that I'm gonna explore things about QDP so that I can help in its documentation

[400Ping]

@ryankert01 As we discussed, I'm up for writing documentation for QDP, with that being a frontend guy, I'd also love to style the website. Shall we discuss and start implementing this in this week's meet? Till that I'm gonna explore things about QDP so that I can help in its documentation

I can also help with some of it as well. Will try to go to the week's sync as well if I can stay awake.

[rawkintrevo]

There's a lot happening here, and i've been out the last couple of days.

We use jekyll because it lowers the friction to developers writing and maintaining talks (via markdown), which we value higher than latest wiz-bang front end. If you can build the content from the markdown files (like jekyll does) then awesome, go for it. But that is why we're using jekyll.

Removing the outdated documentation- the project has existed for over 15 years, there are links all over the internet to admittedly outdated docs- the better solution is to first set up redirects and/or deprication bannes (i believe this was done a while ago). If y'all already nuked the docs (it looks like you have) please set up redirects / better 404 ASAP.

I'm back in pocket now, dm me direct on slack for more info.

[guan404ming]

Sorry about removing the content directly. I understand the concern and I’ve already proposed some remediation steps to address the impact, including adding proper redirects and a custom 404 page so existing links don’t break. I’ve opened #835 to fix this and make sure we handle the legacy documentation more gracefully.