Future Work Widget Metadata
The future work documents have special Frontmatter metadata that is used to power the future-work widget.
Here is an example of what the Frontmatter fields look like:
---
title: Future Work Widget
rfc: https://github.com/thousandbrainsproject/tbp.monty/blob/main/rfcs/0015_future_work.md
estimated-scope: medium
improved-metric: community-engagement
output-type: documentation
skills: github-actions, python, github-readme-sync-tool, S3, JS, HTML, CSS
contributor: codeallthethingz
status: in-progress
---
The following fields are validated against allow lists defined in snippet files to ensure consistency and quality.
Tags
Tags is a comma separated list of keywords, useful for filtering the future work items. Edit future-work-tags.md.
accuracy pose numsteps speed noise learning multi-object generalization compositional deformations features-and-morphology scale real-world dynamic goal-policy abstract adversarial transfer infrastructure oss
Skills
Skills is a comma separated list of skills that will be needed to complete this. Edit future-work-skills.md.
css html javascript s3 content marketing github-actions github-readme-sync-tool interviewing podcasting python research thousand-brains-theory video-editing writing content-creation
Estimated Scope
Very roughly, how big of a chunk of work is this? Edit future-work-estimated-scope.md.
small medium large unknown
Status
Is the work completed, or is it in progress? Edit future-work-status.md.
completed in-progress
Improved Metric
What type of improvement does this work provide? Edit future-work-improved-metric.md.
infrastructure community-engagement
Output Type
What type of output will this work produce? Edit future-work-output-type.md.
documentation
RFC
Does this work item required an RFC? (These values are processed in the validator.py code) and can be of the form:
https://github\.com/thousandbrainsproject/tbp\.monty/.* required optional not-required
Contributor
The contributor field should be GitHub usernames, as these are converted to their avatar inside the table.(These values are processed in the validator.py code) and can be of the form:
[a-zA-Z0-9][a-zA-Z0-9-]{0,38}
Help Us Make This Page Better
All our docs are open-source. If something is wrong or unclear, submit a PR to fix it!
Updated about 6 hours ago