FAQ | This is a LIVE service | Changelog

Skip to content

Resolves: "Investigate PropTypes documentation on docSite"

Mike Bamford requested to merge 32-component-prop-docs into master

This MR implements a tool that can be run to parse a component's *Props interface and update the component's *.doc.mdx with a table documenting the properties.

Possible areas of improvement:

  • We probably need to refine the filtering of the properties.
  • I haven't added it as a commit hook as the tool is fairly slow. However we could have :full option where the default only updates staged files. This might be fast enough for a commit hook.

Closes #32 (closed) & https://gitlab.developers.cam.ac.uk/uis/devops/digital-admissions/admissions-portal/ap-frontend/-/issues/58

Edited by Mike Bamford

Merge request reports