TODO
This commit is contained in:
		
							parent
							
								
									a3114ed235
								
							
						
					
					
						commit
						b7a99d0612
					
				
					 1 changed files with 2 additions and 8 deletions
				
			
		
							
								
								
									
										10
									
								
								TODO.md
									
										
									
									
									
								
							
							
						
						
									
										10
									
								
								TODO.md
									
										
									
									
									
								
							| 
						 | 
				
			
			@ -1,9 +1,5 @@
 | 
			
		|||
# Code structure
 | 
			
		||||
 | 
			
		||||
The Bulma module should be removed.
 | 
			
		||||
The actual Bulma-related code should be in the package [purescript-bulma][psbulma], which currently lacks some features.
 | 
			
		||||
The general style of the website should be in a module.
 | 
			
		||||
 | 
			
		||||
Modules should have their own specific API.
 | 
			
		||||
When a module currently requires to send messages, the API should reflect semantics instead of providing the module a way to just carry raw messages.
 | 
			
		||||
For example, there are currently modules able to send messages (with a very simple `MessageToSend message` API), but instead of dealing with raw messages that need to be built inside the module, the API should be more semantic such as `ChangePassword new-password`.
 | 
			
		||||
| 
						 | 
				
			
			@ -13,7 +9,6 @@ Thus, every state modification can be handled in a single place.
 | 
			
		|||
 | 
			
		||||
Minor modifications:
 | 
			
		||||
 | 
			
		||||
- split `App.Zone` to improve compilation times
 | 
			
		||||
- explanations and static content in general should be written using some kind of templates, not directly in Halogen
 | 
			
		||||
 | 
			
		||||
# Features
 | 
			
		||||
| 
						 | 
				
			
			@ -60,9 +55,8 @@ Details:
 | 
			
		|||
The code should be reviewed and a decent documentation should be provided.
 | 
			
		||||
 | 
			
		||||
Right now, the code is still in a somewhat early stage and **multiple** refactoring should take place.
 | 
			
		||||
For example, modules have a very generic API; they can provide or receive messages from (respectively *to*) authd or dnsmanagerd.
 | 
			
		||||
Instead, modules should have a more specific API and not deal with message encoding at all.
 | 
			
		||||
Furthermore, *maybe* the state of the entire application should be stored in a single module, with a single function handling all state modifications when a message is received, enabling a simpler data management.
 | 
			
		||||
 | 
			
		||||
Some code should be pushed in the [bulma purescript module][psbulma].
 | 
			
		||||
 | 
			
		||||
# TODO in authd and dnsmanagerd
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		
		Reference in a new issue