Project

General

Profile

Rule Maker RFC » History » Revision 3

Revision 2 (Calvin Hutcheon, 05/09/2022 11:16 PM) → Revision 3/5 (Calvin Hutcheon, 05/09/2022 11:20 PM)

# Rule Maker RFC 

 ## Description 

 There's a need for a distributed, general-purpose method that enables any person to author, publish, discover, fetch, scrutinize, prioritize and optionally automate rules on digital networks at scale and with speed.    The Xalgorithms Foundation has created a general purpose free/libre/open method called [DWDS](https://gitlab.com/xalgorithms-alliance/dwds-documents/-/blob/master/current/DBA-Thesis_JPotvin_UQuebec-UQO.pdf). Rule Maker is an interface that enables users to construct rules in a way that is consistent with the Data with Direction specification.  

 Rule Maker adopts a philosophy of iterative development... 

 Given the emergent nature of the interface, Rule Maker is being developed using a methodology of continuous testing 

 RM v0.4 is a webapp built in Svelte 


 ## Features 

 Rule authoring is a complex process comprised of a number of activities. However, only some of these must be supported by RMv4. This diagram shows what is supported in the application and what takes place outside. 


 [figma link](https://www.figma.com/file/Xz37GPQS5Zw5CRf1ljobHM/RM-Activity-Map?node-id=0%3A1) 

 <iframe border="1px solid rgba(0, 0, 0, 0.1);" width="100%" height="450" src="https://www.figma.com/embed?embed_host=share&url=https%3A%2F%2Fwww.figma.com%2Ffile%2FXz37GPQS5Zw5CRf1ljobHM%2FRM-Activity-Map%3Fnode-id%3D0%253A1" allowfullscreen></iframe> 

 This diagram defines all the actions that a user would need to accomplish in rule maker. 

 ![diagram of rule actions](https://xalgorithms.redminepro.net/attachments/download/139/DWDS%20Rule%20Maker%20Action%20Map%20v0.1.0.png) 

 [figma link](https://www.figma.com/file/r2fxTOD3VGA94AHlBUZTKz/DWDS-Rule-Maker-Action-Map-v0.1.0?node-id=0%3A1) <iframe border="1px solid rgba(0, 0, 0, 0.1)" width="800" height="450" src="https://www.figma.com/embed?embed_host=share&url=https%3A%2F%2Fwww.figma.com%2Ffile%2FDqjfZzcD8kYAHEKpMohY1f%2Frule-maker%3Fnode-id%3D0%253A1" allowfullscreen></iframe> 

 A required actions across the main areas of RM 

 - dev 
	 - manifest doc enabling dev to define: 
		 -    path to json doc defining custom metadata fields (aka a [rule template](https://communications.xalgorithms.org/rule-maker/rule-templates/)) 
		 - path to css defining custom styling choices 

 - application 
	 - metadata 
		 - display fields as defined by json document 
		 - structure user input into well formatted json per DWDS 
	 - table editor 
		 - display table editor UI 
		 - structure user input into well formatted json per DWDS 
	 - output 
		 - display fields as defined by json document 
		 - structure user input into well formatted json per DWDS 
	 - publication 
		 - download json 
		 - publish to RR (??) 

 ## Iterative    Development 

 What's been learned so far? 

 ## Developer and User Experience