CommunitySolidServer/documentation/FAQ-for-developers.md
Ian Davis 184a862297
docs: Add basic documentation of config variables
* Add basic documentation of config variables

* Address PR comments

* Added additional documentation based on chat with Joachim

* Import wiki to documentation folder

The reason for this migration is that community members cannot submit
PRs against the wiki to update documentation, so move them here so they
can. Next steps are to deploy this folder as part of the docs CI setup.

* Update README.md

Co-authored-by: Joachim Van Herwegen <joachimvh@gmail.com>

* Address Joachim's comments

Co-authored-by: Joachim Van Herwegen <joachimvh@gmail.com>
2021-03-30 09:46:23 +02:00

467 B

Unable to include my component in the config file

You may be getting an error in the form of:

Error: Invalid components file... Could not expand the JSON-LD shortcut "MyClass". Are all the required modules available and JSON-LD contexts included?'

This could have several causes:

  • The class is not exported from index.ts.
  • The used component name does not correspond to the exported class name.
  • The class has not been compiled using npm run build.