egroupware/doc
Nathan Gray d86d26cc24
Change et2_template to Et2Template webComponent (#169)
* Change template to webcomponent
2025-01-16 13:34:27 -07:00
..
docker
etemplate2 Change et2_template to Et2Template webComponent (#169) 2025-01-16 13:34:27 -07:00
IDE
ldap
mail
REST-CalDAV-CardDAV
rpm-build Changelog for 23.1.20250113 2025-01-13 10:56:03 +01:00
scripts
ad-migration.sh
add_et2_dtd.sh
analyse-warnings.php
check_namespace.php
check-metadata.php
config2xet.php
dovecot-mailbox-status-compare.php
Entry change push update.drawio
Entry change push update.pdf
etemplate2-rng.php
fix_api.php
fix_depricated.php
fix-8.1-depricated-interfaces-return-vals.php
import-mail-credentials.php
js2ts.php
lang_files.txt
ldif2sql.php
LICENSE
links-www.egroupware.org.txt
lotus-structured-text2csv.php
merge-cal-events-by-uid.sh
new-egw-app.php
php_syntax_check.sh
phpunit_bootstrap.php
phpunit.xml
README-dirs-less-css
README.md
test-cli.php
travis-ci-apache.conf
UCS-SAML-SSO.md

Notes on automatic documentation

This is a project in itself. Here's how the pieces fit together:

  • build:dev package script calls /doc/scripts/build.mjs which is responsible for calling the individual pieces. We pass files to the subprocesses, but options are set in a separate config file.
  • /doc/scripts/metadata.mjs extracts the component information using CEM, and stores it to /doc/dist/custom-elements.json
  • /doc/scripts/etemplate2/eleventy.config.cjs uses 11ty to build a documentation site, from the subdirectories in /doc/etemplate2, and stores it to /doc/dist/site

If a component doesn't show up, it's probably not in the manifest.