Refine README.md for clarity on design principles and implementation details; minor code comments adjustments

Author: doofin

README.md

@@ -82,14 +82,14 @@ The project file structure for the VSCode extension module:
 ```
 
 
-## design principles
-I am to design the system with mathematics, algebra and functional programming principles in mind. The system is designed to be modular and extensible, allowing for easy addition of new features and components.
+## design
+I aim to design the system with mathematics and functional programming principles in mind to make it modular and extensible, allowing for easy addition of new features. Ideally, each feature can be represented as a transformation from input to output, where input and output are:
 
     Input = {Query, CodeSnippet, Spec}: The set of all possible input types (queries, code snippets, or requirements/specifications).
 
     Output = {Code, Explanation, Transformation, DebugSuggestion}: The set of all possible outputs.
 
-The types and objects for Input:
+Further explaination of the input and output types:
 - code snippet or code file: a piece of code
 - code context: a code snippet with its surrounding code
 - query: natural language query 
@@ -101,9 +101,17 @@ The Output:
 - transformation: the transformation of the input code
 - suggestion: a suggestion for debugging or improvement or refactoring
 
-# feedback
+# implementation
+features implemented so far:
+- auto completion as you type like copilot
+- add documentation quick fix action(select a function, or some code, and Alt+Enter)
+
+Work in progress:
+- generate multiple files and folders as user specifies
+- disable/enable auto completion
+
 features to be implemented:
-- refactoring
+- select code and ask for refactoring(optimization, bug fixing, etc.)
 - specify which LLM to use
 - RAG(retrieval-augmented generation) to understand the whole code base
 - MCP(model context protocol) to interact with the environment, like external tools, etc.

src/main/scala/functorcoder/actions/CodeGen.scala

@@ -27,7 +27,6 @@ object CodeGen {
     val prompt = llmPrompt
       .Completion(codeWithHole = s"$codeBefore${llmPrompt.promptText.hole}$codeAfter")
 
-    // assistantMessage: String = promptText.prompt1
     llm.sendPrompt(prompt)
   }
 

src/main/scala/vscextension/CodeActions.scala

@@ -21,7 +21,7 @@ object CodeActions {
   def registerCodeActions(context: vscode.ExtensionContext, llm: llmAgent) = {
 
     // https://scalablytyped.org/docs/encoding#jsnative
-    // we need to manually create the js object and cast it
+    // manually create the js object and cast it
     val mActionProvider =
       new js.Object {
         def createCodeAction(
@@ -46,8 +46,7 @@ object CodeActions {
 
               statusBar.showSpininngStatusBarItem(s"functorcoder($language)", llmResponse)
 
-              // there are no onSelect events for code actions
-              // so we need to create a command and set it here
+              // there are no onSelect events for code actions so we need to create a command and set it here
               // edit = new vscode.WorkspaceEdit() {
               //   showMessageAndLog("creating edit") // triggered immediately
               // }

src/main/scala/vscextension/extensionMain.scala

@@ -7,25 +7,19 @@ import typings.vscode.mod as vscode
 
 object extensionMain {
 
-  /** The main entry for the extension, called when activated first time.
-    */
-  @JSExportTopLevel("activate") // Exports the function to javascript so that VSCode can load it
+  // The main entry for the extension, called when editor opens
+  @JSExportTopLevel("activate")
   def activate(context: vscode.ExtensionContext): Unit = {
-    // showMessageAndLog("congrats, your scala.js vscode extension is loaded")
 
     // vscode.workspace.rootPath.getOrElse("")
     val cfg = vscConfig.readConfig()
     val llm = functorcoder.llm.llmMain.llmAgent(cfg)
 
-    // showMessageAndLog(s"config loaded: ${cfg.toString()}")
     // register all commands
     vscCommands.registerAllCommands(context, llm)
 
     // show the status bar
     statusBar.createStatusBarItem(context, llm)
-    // statusBarItem.text = "functorcoder ok"
-    // show the current language of the document
-    // documentProps.showProps
 
     // register inline completions like github copilot
     inlineCompletions.registerInlineCompletions(llm)
@@ -36,21 +30,6 @@ object extensionMain {
     // code actions like quick fixes
     CodeActions.registerCodeActions(context, llm)
 
-    // functorcoder.llm.llmAIMain.test
-    // file operations
-    // io.fileIO.createFile(projectRoot)
-    // load configuration
-    // val cfg = io.config.loadConfig(projectRoot + "/.vscode/settings.json")
-    // showMessageAndLog(s"config loaded: $cfg")
-
-    // language server client
-    // lsp.startLsp()
-
-    // webview
-    // webview.showWebviewPanel()
-
-    // editor config
-
   }
 
 }

src/main/scala/vscextension/inlineCompletions.scala

@@ -29,6 +29,7 @@ object inlineCompletions {
         val codeBefore = document.getText(new vscode.Range(new vscode.Position(0, 0), position))
         val codeAfter = document.getText(new vscode.Range(position, document.positionAt(document.getText().length)))
 
+        // the core logic to get the completion from the llm
         val promptResponseF = CodeGen.getCompletion(codeBefore, codeAfter, llm)
 
         val providerResultF: Promise[scala.scalajs.js.Array[vscode.InlineCompletionItem]] =