docs.nestjs.com icon indicating copy to clipboard operation
docs.nestjs.com copied to clipboard

RFC: Using Scully

Open BrunnerLivio opened this issue 2 years ago • 3 comments

I'm submitting a...

  • [ ] Regression
  • [ ] Bug report
  • [x] Feature request
  • [ ] Documentation issue or request (new chapter/page)
  • [ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

At the moment we have to maintain components which use auto-generated HTML from Markdown files. On top of that the router needs to be configured using the NgRouter.

Expected behavior

Scully would allow to easily transform MD into HTML, while also dynamically generate the routes & navigation.

What is the motivation / use case for changing the behavior?

Easier to maintain the docs + potentially enables #413

BrunnerLivio avatar Mar 09 '22 00:03 BrunnerLivio

TBH I haven’t tried out Scully myself. It seems less mature than GastbyJS or NextJS, but it may suffice for this documenation.

Nonetheless, if you’d see benefit in using it I could explore the possibilites and setup a draft PR.

BrunnerLivio avatar Mar 09 '22 00:03 BrunnerLivio

Another option would be a tool like astro (working on using it for my ogma documentation) and it can use Vue and react components during compilation while using the minimal amount of JS in the final build

jmcdo29 avatar Mar 09 '22 00:03 jmcdo29

Given that the application (docs app) already exists and is in pretty good shape, are we sure there's a viable reason to invest so much time to basically migrate to another tool? I feel like at this point this would be just a waste of time TBH

kamilmysliwiec avatar Mar 09 '22 07:03 kamilmysliwiec