Create a search based document for autodoc

.fdignore

@@ -0,0 +1,5 @@
+.*
+assets
+LICENSE
+package-lock.json
+docs

docs/.gitignore

@@ -0,0 +1,5 @@
+!.gitignore
+!*
+!*/*
+cache_db.json
+cache_tree.json

docs/cache_title.json

@@ -0,0 +1 @@
+{"_default": {"1": {"path": "/README.md", "hash": "e6ffb927761de1de5c91b6ed5d04bcb4", "title": "Autodoc: Open-Source Codebase Documentation Tool"}, "2": {"path": "/README.md:2-22", "hash": "7edf17c7aa1a2948cb173cd017853543", "title": "Auto-generate Code Documentation with Autodoc"}, "3": {"path": "/README.md:23-36", "hash": "0455654f9483a8f0314862bef21d039d", "title": "Auto-Generating Code Docs with Autodoc"}, "4": {"path": "/README.md:38-48", "hash": "8952940e45206a0978c99525f3088b33", "title": "Early-Stage Autodoc Status and Contributions"}, "5": {"path": "/README.md:49-66", "hash": "29136e119a09008ca8ca34559b5b1adc", "title": "Autodoc: Documentation Tool Examples"}, "6": {"path": "/README.md:67-102", "hash": "febbce92c564fed32ef6e74c8cc6da07", "title": "Install Autodoc CLI and Query Repository"}, "7": {"path": "/README.md:104-129", "hash": "d9495918b1bdb038bbe1cae7f3273b07", "title": "Autodoc Setup Guide"}, "8": {"path": "/README.md:129-144", "hash": "05f640ecdb3cb031b8da8997312d2697", "title": "Generate and Store GPT Model Configurations"}, "9": {"path": "/README.md:144-148", "hash": "5b72eee048d8aa37f8bb5603caf22114", "title": "Indexing Autodoc with Model Selection"}, "10": {"path": "/README.md:150-161", "hash": "0f8c3e8cd6242830208e7e842266e607", "title": "OpenAI Pricing and Future Roadmap"}, "11": {"path": "/README.md:164-168", "hash": "59d60cd09522259d709961f3efb7fc99", "title": "Join the Open Source Movement"}, "12": {"path": "/autodoc.config.json", "hash": "9f317f6309c143cf89b9696d49e93b8d", "title": "Configuring Autodoc: Markdown Output"}, "13": {"path": "/autodoc.config.json:1-24", "hash": "9fed47876a81f9e496519ba8fdcbd02e", "title": "Autodoc Configuration File"}, "14": {"path": "/autodoc.config.json:24-29", "hash": "26c910da54db24888f5b3f1423a3b386", "title": "Smart Dev Docs Config"}, "15": {"path": "/package.json", "hash": "84c53c4db80f741d21225d681c3d11df", "title": "TypeScript Autodoc Builder"}, "16": {"path": "/package.json:1-46", "hash": "fe4c0896e34b2fd03326ad19d1bdd14b", "title": "Autodoc Toolkit for TypeScript"}, "17": {"path": "/package.json:47-64", "hash": "dccd9d8d439e6e1001aed4bfd09a2f0c", "title": "Comprehensive Typescript Dependencies in package.json"}, "18": {"path": "/src/cli/commands/estimate/index.ts", "hash": "f9b5b0ad62b5cb13a5277df796227c13", "title": "Estimate OpenAI Repository Cost"}, "19": {"path": "/src/cli/commands/estimate/index.ts:1-49", "hash": "b4683ed817c7dd0066580a2e33aca3b9", "title": "Estimate Cost of Indexing Repository"}, "20": {"path": "/src/cli/commands/estimate/index.ts:50-70", "hash": "e3a97b9cfc1035971b41983b82dcd75a", "title": "Estimate Repository Cost Function"}, "21": {"path": "/src/cli/commands/index/convertJsonToMarkdown.ts", "hash": "606ce83bddc05016ceb4096ae0339743", "title": "JSON to Markdown Converter"}, "22": {"path": "/src/cli/commands/index/convertJsonToMarkdown.ts:1-44", "hash": "77718aa2a8ebc037f68e8042a1b12967", "title": "Convert JSON to Markdown Function"}, "23": {"path": "/src/cli/commands/index/convertJsonToMarkdown.ts:46-86", "hash": "f7d5117ca788bcf2a72fdea8b020e5d8", "title": "Convert JSON to Markdown"}, "24": {"path": "/src/cli/commands/index/convertJsonToMarkdown.ts:87-103", "hash": "3445d377956b1265850971dae8df07bd", "title": "Convert JSON to Markdown and Generate Files"}, "25": {"path": "/src/cli/commands/index/createVectorStore.ts", "hash": "07049e8ed531056bd02ab325e2886b41", "title": "Create Vector Store Command"}, "26": {"path": "/src/cli/commands/index/createVectorStore.ts:1-31", "hash": "8cb6e88080688801f9aaaf428174b304", "title": "Reads File, Resolves Document"}, "27": {"path": "/src/cli/commands/index/createVectorStore.ts:32-70", "hash": "4c09152c829b4cd289c2786d3935073b", "title": "Directory-Based Document Loader"}, "28": {"path": "/src/cli/commands/index/createVectorStore.ts:71-78", "hash": "26308bca8b5a6ec48657c5a0f7da3c26", "title": "Split, Vectorize and Store Documents"}, "29": {"path": "/src/cli/commands/index/index.ts", "hash": "9c8d828fa0f12b90521aec5d0d0cff4b", "title": "Efficient Repository Indexing"}, "30": {"path": "/src/cli/commands/index/index.ts:1-42", "hash": "0bfdce9af0130b5366638bdb25402c62", "title": "Traverse, Process, and Store Repository Data"}, "31": {"path": "/src/cli/commands/index/index.ts:43-94", "hash": "873725772a4d85b346f7ecbde106680e", "title": "Repository Processing and Conversion Tool"}, "32": {"path": "/src/cli/commands/index/index.ts:95-101", "hash": "e3859377ab780d6359457df4990ec051", "title": "Defines and Exports index Function"}, "33": {"path": "/src/cli/commands/index/processRepository.ts", "hash": "1fa29c6a9e38788e7ed32b020b97204d", "title": "Repository Processing and Prompt Generation"}, "34": {"path": "/src/cli/commands/index/processRepository.ts:1-43", "hash": "81926c8c3b5db31ff1db4c8155171741", "title": "Automated Repository Summary Generation"}, "35": {"path": "/src/cli/commands/index/processRepository.ts:44-87", "hash": "d7d01e70b36a5b225d8a17807571e532", "title": "Process Repository and Calculate Checksum"}, "36": {"path": "/src/cli/commands/index/processRepository.ts:88-129", "hash": "c08ec948cbd04c6c83e5f91ada1e01a1", "title": "Automate Markdown Indexing and Summary Generation"}, "37": {"path": "/src/cli/commands/index/processRepository.ts:130-167", "hash": "5faea3b33f0b436c9f51aee8f7175eb9", "title": "Asynchronous LLM File Summary Generator"}, "38": {"path": "/src/cli/commands/index/processRepository.ts:168-209", "hash": "222924e8aa9c4524248e4af315874040", "title": "Folder Indexing and Checksum Process"}, "39": {"path": "/src/cli/commands/index/processRepository.ts:210-247", "hash": "2172ff53b344550d05ea0fcfbcec2500", "title": "Checks Summary JSON for Reindexing"}, "40": {"path": "/src/cli/commands/index/processRepository.ts:248-287", "hash": "30fc36d9ad9c6449fa82da18d4cef6a8", "title": "Directory Summary Parsing and LLM Integration"}, "41": {"path": "/src/cli/commands/index/processRepository.ts:288-335", "hash": "a5d910a326a834808e79c510629f3b58", "title": "Folder Summary Generator"}, "42": {"path": "/src/cli/commands/index/processRepository.ts:336-387", "hash": "e022ae652ee0521cf976f7c00953cd7e", "title": "Process Repository: Count Files & Folders"}, "43": {"path": "/src/cli/commands/index/processRepository.ts:388-435", "hash": "2ba5154dfe9df01ab7a5e436dbc8e1c7", "title": "Reindexing Summary Based on Checksums"}, "44": {"path": "/src/cli/commands/index/processRepository.ts:437-453", "hash": "69217da350bc2f1eab9ff8b157542d81", "title": "Verify and Reindex Summary File"}, "45": {"path": "/src/cli/commands/index/prompts.ts", "hash": "0609658f7a8d469f4650da797b84e3df", "title": "Prompt Generator Functions"}, "46": {"path": "/src/cli/commands/index/prompts.ts:1-35", "hash": "9c995abe8bddbfc72f88253c38f666de", "title": "Generate Code File Summaries and Questions"}, "47": {"path": "/src/cli/commands/index/prompts.ts:37-79", "hash": "1bc2742484a86ce8a703cd06f5fa5178", "title": "Folder Summary Prompt Documentation"}, "48": {"path": "/src/cli/commands/index/prompts.ts:81-83", "hash": "2cf8c3d7af962c772ca66e9d1405db50", "title": "Setting Response Variable with Semicolon"}, "49": {"path": "/src/cli/commands/index/selectModel.ts", "hash": "0fd432e5784d98e6b728edb497ef2afc", "title": "Optimal LLM Model Selection"}, "50": {"path": "/src/cli/commands/index/selectModel.ts:1-35", "hash": "86cd0dfd7e3bea51d06ba780b4c8136a", "title": "Cost-effective LLM Model Selection"}, "51": {"path": "/src/cli/commands/index/selectModel.ts:36-57", "hash": "d90054c1f5e17c29b86809fa98cf08bd", "title": "Optimizing Model Selection based on Prompt Length"}, "52": {"path": "/src/cli/commands/init/index.ts", "hash": "0933dd49f9fd5100f1be2550679800c3", "title": "Autodoc Initialization Command"}, "53": {"path": "/src/cli/commands/init/index.ts:1-39", "hash": "1ca6d79d6fd149e000f6047220cf8163", "title": "Create AutodocRepoConfig Template"}, "54": {"path": "/src/cli/commands/init/index.ts:40-61", "hash": "be8b6d812077e5c87be3dfcda272c3ea", "title": "Defining CLI `init` Command Variables and Functions"}, "55": {"path": "/src/cli/commands/init/index.ts:62-100", "hash": "ebcc1b68d86ca74eb0be29135ecdff16", "title": "Confirm Overwrite before Init"}, "56": {"path": "/src/cli/commands/init/index.ts:101-139", "hash": "1ec3eb6338281b7a079401ad83f2133c", "title": "CLI Initialization: Choose LLM and Documentation Prompts"}, "57": {"path": "/src/cli/commands/init/index.ts:140-155", "hash": "9f56f7f8d51f36d987e34ba907a6b1d0", "title": "Autodoc Initialization and Configuration"}, "58": {"path": "/src/cli/commands/query/createChatChain.ts", "hash": "13a9cd0c38cc3b12ba7cc2b760b6c01c", "title": "Create Chat Chain Prompt Template"}, "59": {"path": "/src/cli/commands/query/createChatChain.ts:1-20", "hash": "bace8c775db1605d53130c45ca482ee4", "title": "Generate Standalone Questions from Chat History"}, "60": {"path": "/src/cli/commands/query/createChatChain.ts:21-31", "hash": "faf64e268896e637dedc74527042a07d", "title": "Guidelines for Informative Chat Chain Responses"}, "61": {"path": "/src/cli/commands/query/createChatChain.ts:31-73", "hash": "c1bf9e70edf409a04368509bed7339c5", "title": "Create Chat Chain with OpenAI API"}, "62": {"path": "/src/cli/commands/query/createChatChain.ts:74-90", "hash": "d3be2f8cc5e63abddc5b95670a051bf6", "title": "Create ChatChain Instance"}, "63": {"path": "/src/cli/commands/query/index.ts", "hash": "4817d3cc5d568930cf9b3197acea40b1", "title": "CLI Query Chatbot Interface"}, "64": {"path": "/src/cli/commands/query/index.ts:1-31", "hash": "9a5398d71b77f523d1d2516344109cef", "title": "Chatbot Command Initialization"}, "65": {"path": "/src/cli/commands/query/index.ts:32-78", "hash": "dddd74f8d4511f62cc8cc8fbc99d2de3", "title": "User-Driven Chain Prompt"}, "66": {"path": "/src/cli/commands/query/index.ts:80-86", "hash": "3527367a8b7b2729acf30e72ddbf738b", "title": "Retry with Error Logging"}, "67": {"path": "/src/cli/commands/user/index.ts", "hash": "53f9011e58a88ef30a536ebfbe8acffe", "title": "User Configuration Manager"}, "68": {"path": "/src/cli/commands/user/index.ts:1-39", "hash": "e1a1d6157919c0c207c779c6b5790c7f", "title": "Create or Update Autodoc User Config"}, "69": {"path": "/src/cli/commands/user/index.ts:40-86", "hash": "c5b5202cafcbb35b6d05342bd9b14b94", "title": "User Configuration Manager for Autodoc CLI"}, "70": {"path": "/src/cli/commands/user/index.ts:87-88", "hash": "a634d50081b229a562240dff3590780b", "title": "Closing Braces Function"}, "71": {"path": "/src/cli/spinner.ts", "hash": "ee3bb0365972dd9646d8428faae21567", "title": "Spinner Manager Functionality"}, "72": {"path": "/src/cli/utils/APIRateLimit.ts", "hash": "aaf93dc81bebf8653ee3fc12030f138a", "title": "Rate-Limited API Calls in APIRateLimit.ts"}, "73": {"path": "/src/cli/utils/APIRateLimit.ts:1-38", "hash": "d0eee0904225302b61a04bda3228344a", "title": "API Rate Limiting with Queue"}, "74": {"path": "/src/cli/utils/APIRateLimit.ts:39-39", "hash": "e5c346cfd073179eab2850d1410c0cf4", "title": "Closing Brace Detection"}, "75": {"path": "/src/cli/utils/FileUtil.ts", "hash": "cdcc8b2f6d2acb81bccdfff1273c6df1", "title": "File Utilities: Get Filename, GitHub URLs"}, "76": {"path": "/src/cli/utils/LLMUtil.ts", "hash": "b2c9f57115ac090e8bd9879d366026f6", "title": "LLM Cost Estimation Tool"}, "77": {"path": "/src/cli/utils/LLMUtil.ts:1-41", "hash": "7e36abffd5c2eba1b9bebb0161a08a1c", "title": "LLM Utilities for OpenAI Models"}, "78": {"path": "/src/cli/utils/LLMUtil.ts:42-81", "hash": "1ea7b1ee72574fa3fca490411d5e1efd", "title": "Initialize and Print LLM Model Details"}, "79": {"path": "/src/cli/utils/LLMUtil.ts:82-104", "hash": "3d03def21539668b4ea97c285fdb3313", "title": "Total Index Cost Estimator for LLM Models"}, "80": {"path": "/src/cli/utils/WaitUtil.ts", "hash": "80b00d327c293a216264fc157fb15e15", "title": "Async Timeout Utilities"}, "81": {"path": "/src/cli/utils/traverseFileSystem.ts", "hash": "a79b4228dd82b41b090bb7173a3266c9", "title": "Asynchronous Depth-First File System Traverser"}, "82": {"path": "/src/cli/utils/traverseFileSystem.ts:1-41", "hash": "a8f66788f2c1771337dcf84f45f63d55", "title": "Asynchronous File System Traversal"}, "83": {"path": "/src/cli/utils/traverseFileSystem.ts:42-80", "hash": "7c21439a46446f151f03d89a5dd43b71", "title": "Depth-First Search File System Traverser"}, "84": {"path": "/src/cli/utils/traverseFileSystem.ts:81-94", "hash": "a0adc812c69388bba9a3cadfd307806d", "title": "Depth-First Search File System Traverser"}, "85": {"path": "/src/const.ts", "hash": "44cd1e224c32617fe4c4f7c51511f015", "title": "Import and Set User Config Path"}, "86": {"path": "/src/index.ts", "hash": "f474e46c6102a2ea2c15482505cfdc46", "title": "Autodoc CLI Tool Initialization"}, "87": {"path": "/src/index.ts:1-31", "hash": "d95f6c51f1d909f009bec3305aff2ccb", "title": "Initialize Autodoc Repository"}, "88": {"path": "/src/index.ts:32-76", "hash": "1a4edfd5770666300373526737cde77f", "title": "CLI Commands for 'estimate' and 'index'"}, "89": {"path": "/src/index.ts:78-121", "hash": "1138dc36bcf1f2845164199dc5d2deff", "title": "Command-line Autodoc Indexing Tool"}, "90": {"path": "/src/index.ts:122-157", "hash": "87d9eadb94f8720d83349815de7fdb41", "title": "Config File Handling and Error Management"}, "91": {"path": "/src/langchain/hnswlib.ts", "hash": "aa8c01e48e176b75d26ffc089d8183c4", "title": "HNSWLib: Saving, Loading, and Searching Vectors"}, "92": {"path": "/src/langchain/hnswlib.ts:1-38", "hash": "57bc2998fcd7ecece4c59f2d6cf7b34a", "title": "HNSWLib: SaveableVectorStore Extension"}, "93": {"path": "/src/langchain/hnswlib.ts:39-72", "hash": "9ed7466f8622170054bcb45bc2c5d15a", "title": "Create HNSW Index from Texts and Embeddings"}, "94": {"path": "/src/langchain/hnswlib.ts:73-102", "hash": "cb408c0f667f3d800736ef8998ad1a5f", "title": "Initialize and Add Vectors/Documents to HNSW Index"}, "95": {"path": "/src/langchain/hnswlib.ts:103-131", "hash": "f21148b87b64136929337bdd3d4d7280", "title": "Vector Index and Search Function"}, "96": {"path": "/src/langchain/hnswlib.ts:132-165", "hash": "4f4a8df0437a5383019fe120679c49d0", "title": "HNSWLib: Save and Load Methods"}, "97": {"path": "/src/langchain/hnswlib.ts:166-208", "hash": "0230329ded2d1de3626afc232ceb1ecc", "title": "HNSW Indexing with Embeddings"}, "98": {"path": "/src/types.ts", "hash": "6624fb6972e879389243aee214bdebde", "title": "Automated Documentation Types"}, "99": {"path": "/src/types.ts:1-53", "hash": "6a039540c73d609b73ff42161e892833", "title": "Exported Types for Automated Documentation"}, "100": {"path": "/src/types.ts:54-104", "hash": "07a0fa8ad08cabe08bfb25bddead90c7", "title": "Defining Types for Parameters and Enums"}, "101": {"path": "/src/types.ts:105-106", "hash": "c480eef718f004cf0c6597d7f7d8d956", "title": "Enum for Performance Metrics"}, "102": {"path": "/tsconfig.json", "hash": "b9e791a7e13e37bcad56930b2e166ace", "title": "Configure TypeScript Compiler Options"}}}