search

redwoodjs / redwoodjs-com-archive

Public website for RedwoodJS
https://redwoodjs.com
129 stars 156 forks source link

Automation #576

Open jtoar opened 3 years ago

jtoar commented 3 years ago

As we're approaching v1, we should start thinking more about automation.

The problem with docs is that they're almost always behind. At best they're on time, but they're almost never ahead. (With the Tutorial, Redwood might actually be the exception here!)

I've only skimmed the marketplace, but I don't see that much available in the way of automation. One kind of "automation" I imagine being useful though is the ability to indicate some sort of dependency, like "this doc depends on these files in the repo"—when those files change, it signals that this doc might be outdated.

If we improved the tooling on redwoodjs/redwood repo, then that case might be covered. But it's worth thinking about ways things could be improved.

jtoar commented 3 years ago

One thing I've noticed is that some of the links in the nav on the right in some pages don't work. Maybe we could add a Cypress test that checks to see that they're working properly? Not sure if that's overkill, but it's definitely an area that needs some TLC.

thedavidprice commented 3 years ago

We will need Versioning capability post-v1. As a reference, here's how Docusaurus2 does it.

cannikin commented 3 years ago

I believe the plan is to move all docs to learn.redwoodjs.com so that we can have locale support, and that’s already using Docusaurus 2.

cannikin commented 3 years ago

One thing I've noticed is that some of the links in the nav on the right in some pages don't work.

Hmm the links over there are created based on the titles on the main body so I’m not sure why some would work and others don’t...do you have a specific doc where you’re seeing the issue?

AntonioMeireles commented 3 years ago

while on this - one think that may make sense to add to the radar, in the near future, is as the project is moving towards being more typescript aware is to start using typedoc on the stock rw source tree and then have the generated docs site as companion data (API level) to the main documentation site.

jtoar commented 3 years ago

@cannikin Clicking through titles now and all of them seem to be working great! If I find an example I'll report back. I feel like a title that had apostrophes or some other punctuation mark was buggy, but it's not resurfacing.

Opened an issue about the CLI Commands doc (#579) which does have some clashing links though.