Skip to content

Conversation

@Monika-Bolla
Copy link

Hello,

This PR generates the Typedoc handbook and includes the generated docs/handbook folder for preview.

What I did
Added typedoc.json to configure Typedoc (skip errors, exclude tests)
Ran Typedoc to build the handbook
Force-added the docs/handbook folder since it was gitignored

Why
Enables maintainers to easily preview the generated docs
Solves build issues where Typedoc previously failed due to TS errors

Let me know if you’d prefer me to set up a GitHub Action to build and deploy this instead of committing the docs folder

@bolt-new-by-stackblitz
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@dariomannu
Copy link
Contributor

Hi @Monika-Bolla the docs shouldn't be checked in git, as they're meant to be auto-generated. Otherwise you'll have these mega-commits with hundreds of "changed" files. If you can please take the actual docs off...

@dariomannu
Copy link
Contributor

Hi @Monika-Bolla looks like you also removed manually-generated doc files, like [‎docs/migrating/angular.md](https://github.com/ReactiveHTML/rimmel/pull/55/files#diff-fb53612b98eb1a1752025b4cb841e0be64788d15f80a876cc7a0904789b35d15).

It's only the auto-generated Typedoc documentation that we need out of configuration management.

@dariomannu
Copy link
Contributor

Whops... now you removed everything except that one file. If you check the "files changed" tab, you'll see what is going to be merged and check if it does indeed contain your changes and nothing else. Shout if you're stuck.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants