Opened 6 hours ago
#20336 new task
Documentation templates
| Reported by: | Zach Pearson | Owned by: | |
|---|---|---|---|
| Priority: | moderate | Milestone: | |
| Component: | Documentation | Version: | |
| Keywords: | Cc: | chimerax-programmers | |
| Blocked By: | Blocking: | ||
| Notify when closed: | Platform: | all | |
| Project: | ChimeraX |
Description
As we all know, Elaine's retirement stands to increase developers' documentation workloads significantly. One issue is that all of our documentation is written in plain HTML. We should consider using a thin static site generator like Astro, which would save a lot of tedious formatting. One of Astro's strengths is that components can be written in React or Vue or plain HTML. It's pretty flexible and agnostic.
One of Astro's biggest strengths is that it can be used piecewise in the sense that you can just rename an HTML file to .astro and it works unchanged, even if you gradually change it to lean on features like templates.
I'll make a test branch.