MIP#29
Vote Option:
Yes [MVC constructs and maintains an extensive technical knowledge base, incurring an initial cost of USD 80,000 worth of space during the initial phase and USD 5,000 worth of space monthly during the maintenance phase.]
NO [MVC do not construct and maintain technical knowlege base.]
Motivation:
The MVC project, developed through distributed collaboration, leverages and enhances various traditional blockchain technologies but faces significant documentation and knowledge dissemination challenges across platforms like GitHub, Medium, Discord, and Telegram. This fragmentation complicates MVC's adoption, especially for developers unfamiliar with Bitcoin's UTXO contract mode. MVCDAO's technical inquiries from the web3 ecosystem highlight the need for detailed documentation on node setup and usage, smart contracts, mining instructions etc. The scattered documentation and high knowledge barrier hinder MVC's technological showcase to external parties, affecting its market image and necessitating a unified knowledge base to facilitate easier access and understanding for both developers and users.
Executive Summary:
The proposal aims to establish and maintain a high-quality knowledge base for the MVC brand, enhancing its image and supporting ecosystem development. The project, managed by a professional team of MVC developers, is structured into two phases:
Initial Construction Phase: Focuses on setting up a website, designing documentation standards, collecting technical content, and supporting multiple languages. It requires an $80,000 budget and aims for completion within 3 months. Key deliverables include an operational website, 80+ open-source documentations, and bilingual(English and Chinese) support.
Maintenance Phase: Involves ongoing updates and the addition of at least three new documents monthly. It has a $5,000 monthly budget. The phase emphasizes maintaining accessibility, document accuracy, and incorporating community feedback.
Overall, the initiative seeks to create a comprehensive, open-source documentation library to serve the MVC community, requiring significant initial and ongoing investment.
Details:
The creation of MVC was accomplished through distributed collaboration among multiple teams, while MVC's technology draws from and improves upon many traditional blockchain technologies. This background means that MVC's technological scope is very broad, yet the knowledge and documentation are scattered across various places, such as GitHub, Medium, Discord, and Telegram bots. The collaborative development teams of MVC have also focused their main efforts on product development and the implementation of new features, lacking a unified documentation and knowledge base to systematically introduce MVC's innovative technologies and the underlying principles supporting them.
This situation poses great difficulties for developers without a Bitcoin UTXO contract development background or experience. Many novice developers or those from the ETH blockchain community find it challenging to participate in MVC development. The lack of comprehensive documentation is one reason, and another is the fundamental difference between the development paradigms of Bitcoin's UTXO contracts and those of the ETH series, making it difficult to directly apply existing development experience. The tools for Bitcoin contract development are also relatively immature, and there is a lack of tutorials and example codes for contract developers to reference. Documentation is scattered and lacks unified management and systematic organization, further raising the barrier to development.
MVCDAO has also received feedback and questions from web3 ecosystem partners (such as exchanges, mining pools, wallet providers, etc.) and users. Here are some main and typical technical questions selected:
Node setup and deployment, detailed configuration parameters and their meanings, computational resources needed for node operation, and recommended configurations. Peer nodes ip addresses or public seed servers.
Differences and similarities between MVC and Bitcoin nodes, RPC methods available, their parameters, and how to call them.
Differences between MVC and Bitcoin transaction formats, support for multisig, SegWit, Taproot, and inscriptions.
How to mine MVC, whether GPUs or CPUs can mine, rewards for running nodes, how to configure nodes to handle more transactions. How to connect to mining pools, their fees, difficulty, total network hash rate, and return on investment.
What is MetaTxid? Why is it a major innovation of MVC, and the problems it solves. What is MetaId, and why it can serve as a personal web3 identity entry. What are the technical details of those innovations.
What is 0-confirmation, why wallet receipts are almost instant, but depositing to exchanges takes several hours.
What are MVC smart contracts, differences between UTXO contracts and Ethereum contracts, how to use the scrypt contract language, its syntax, and how to write, compile, and deploy contracts.
What are MVC's standard contracts, how are ft, nft, unique, sell, dao contracts implemented, and are they safe and audited?
Does MVC have an SDK for easily minting tokens? What functionalities can the meta-contract library achieve, and how to use it?
MVC indexer and browser, how to use mvcscan to view MVC transaction statuses, how to run indexer services to index transactions and assets, and how to call the MVCApi public REST service for indexing.
Each of these questions represents a broad category of issues, where explaining each clearly requires extensive professional documentation and interpretation. Accurately answering these questions requires professional knowledge and skills, as well as ample development experience. Previously, domain-specific and categorized knowledge was maintained and answered by specific development teams, which is the fundamental reason for the scattered and disorganized documentation. Additionally, due to the high barrier of cross-disciplinary knowledge, it is challenging for a single team to thoroughly grasp all areas of knowledge, thus unable to manage and maintain a knowledge base uniformly. Maintaining a unified knowledge base requires collaboration across various development teams.
The lack of technical documentation poses a serious issue, especially when the MVC community seeks to promote and showcase externally. External investors and partners may scrutinize MVC's technological innovations, and without technical documentation, MVC struggles to present a systematic technical showcase. Many concepts and innovations remain merely superficial descriptions on PowerPoint presentations, making it difficult to distinguish MVC from scam projects or vaporware, negatively impacting MVC's image building and market promotion.
Furthermore, due to the decentralized nature of the technical community and teams, it's challenging for users to directly find the relevant team to resolve issues or answer queries. There's also a need for a technically-oriented discussion community to match professional developers with users, enhancing the usability experience of the MVC chain.
Proposal
To address the issues outlined above, we propose the construction and maintenance of a high-quality knowledge base and technical documentation repository to enhance the MVC brand and product image. We suggest establishing a unifiedly managed knowledge base and technical community, organizing experts from various fields to regularly maintain documents and knowledge. The knowledge base aims to achieve the following strategic objectives:
Technical Entry: A clear documentation and knowledge base management structure, making it easier for users and developers to find knowledge in various fields.
Beginner's Guide: Guiding developers and ecosystem partners from zero to one in participating in MVC ecosystem development and cooperation.
Product Card: Sharing and promoting MVC core technology,showcasing MVC's solutions and advantages from a professional technical perspective, available for review and collaboration by all in the open-source community.
Version Management: Maintaining the latest technology and updates in real-time. Preventing documentation from becoming obsolete due to updates in technology and tools.
Open Source and Open Access: The documentation library is fully open-source and accessible, establishing a cooperative and management scheme for open-source documentation, allowing multiple teams to collaborate on document maintenance. The knowledge base maintained by MVC is considered a shared asset for humanity, freely accessible to the open-source community.
Tutorials and Example Codes: Demonstrating how to use MVC ecosystem tools for development through tutorials and example codes, while also maintaining the accuracy of these tutorials and debugging tutorial codes and tools.
Market Promotion: Utilizing SEO optimization to funnel solutions to many technical problems into MVC documentation, aiding in brand exposure and promotion.
Collection and Integration: Incorporating classic technical documents or columns from external sources and integrating them with MVC's technical solutions. If it grows to scale, the MVC knowledge base hopes to become a hub for BVM technology.
Achieving these goals requires significant time and effort, as well as cooperation and collaboration from expert engineers across various fields. Thus, this project requires substantial initial and ongoing investment.
Project Implementation Entity
The project will be managed and maintained by a professional third-party knowledge base team commissioned by mvclabs, consisting of at least five professional MVC developers. This team possess mature development experience and professional knowledge to ensure the accuracy and professionalism of the knowledge base. Given the content is fully open source, the community is also welcomed to submit modifications, with accepted contributions being compensated after team review and audit.
The construction of the proposal knowledge base is divided into two phases: the initial construction phase and the maintenance phase.
Initial Construction Phase
The initial construction phase requires a significant amount of initial work, including but not limited to:
Setting up a documentation website and platform, providing domain names and server resources for running the knowledge base. The entrance page needs professional design and production due to its role as a product card (initial work volume accounts for 10%).
Designing open-source cooperation frameworks and documentation management standards (initial work volume accounts for 5%).
Collecting and organizing content covering over 70% of the current technological fields, compiling and debugging codes in technical documents to ensure accuracy (initial work volume accounts for 70%).
Supporting multiple languages, initially at least supporting English and Chinese considering the scale of the communities, including translation and proofreading work (work volume accounts for 15%), with provisions for other languages in the future.
During the initial construction phase, the technical document fields to be covered must include, but are not limited to, node setup, configuration, RPC manual, Bitcoin basics, mining guides, MetaTxid and MetaId columns, Scrypt contract language tutorials, standard contract analysis, meta contract SDK usage, and public API documentation, ensuring a coverage rate of over 70%.
Funding Request and Usage
For the initial phase, a request for $80,000 USD equivalent in space is made.
The payment will be linearly released over three months based on progress and achievements in the building project.
Timeline and Deliverables
Given that the bulk of the work is concentrated at the project's outset, most activities will undergo an intensive effort during the initial phase. Construction will commence following the approval of the MIP vote, with an aim to complete the initial delivery within 3 months after the vote passes. The delivery must meet the following requirements:
Knowledge Base Website and Domain Online: The knowledge base website and its domain should be operational and accessible.
Open-Source Documentation: All documents within the knowledge base must be open-source, covering at least 70% of the required fields.
Bilingual Support: The knowledge base should support both English and Chinese language switching to accommodate the scale of these communities.
To achieve these deliverables, the initial phase budget of the project will involve:
Knowledge Base Website Construction and Deployment: This includes the artistic design of the homepage and the construction of the documentation framework. This initial effort accounts for 10% of the workload, with a budget of $8,000.
Open-Source Cooperation Framework Design: Designing the document management standards and establishing management processes. This effort represents 5% of the workload, with a budget allocation of $4,000.
Collection and Organization of Technical Content: This involves gathering content that covers more than 70% of the current technological fields and content, compiling and debugging codes in technical documents to ensure accuracy. This task is the most significant, comprising 70% of the workload, and is budgeted at $56,000. It includes the creation and proofreading of over 80 detailed professional chapters and articles.
Multilingual Support: Given the significance of both English and Chinese-speaking communities, the documentation library will initially need to support these two languages, requiring translation and proofreading. This task accounts for 15% of the workload, with a budget of $12,000, including the translation and proofreading of over 80 chapters and articles. Provision for additional languages will be considered for the future.
These efforts aim to create a comprehensive and accessible knowledge base that can serve as a valuable resource for developers, partners, and users within the MVC ecosystem, facilitating better understanding, development practices, and collaboration across the community.
Maintenance Phase
After the initial phase, although most of the knowledge base construction will be complete, ongoing maintenance and updates are necessary to keep pace with MVC's development. This will involve costs for website server and maintenance, payments to professional engineers for document updates and maintenance, and compensation for community-contributed technical columns or copyright fees.
The maintenance phase promises to add or include at least three new open-source technical documents every month.
Funding Request and Usage for Maintenance Phase
For ongoing maintenance, $5,000 USD equivalent in space is requested monthly, with the amount adjusted based on space price.
The knowledge base team commits to ensuring the accessibility of the documentation site, the correctness of documents, and the regular output and inclusion of technical documents (3 articles/month).
Monthly budget applications and distributions will be reported to the MVCDao committee for review, and clear accounting records will be maintained. The monthly budget payments will be halted if over 60% of the members decide to stop the payments at any time.
Delivery of Results
The knowledge base team continuously guarantees the accessibility of the website, updates and bug fixes, and bears the cost of traffic and equipment, adding new functions to enhance the convenience of the knowledge base (e.g., adding AI Q&A features).
They commit to producing or including at least three high-quality technical documents each month and accept community submissions for review. The technical review team has the right to decide the quality and payment of the submission.
Approved documents will be compensated, and copyright for accepted articles will be owned by mvcdao and shared openly.
Disclaimer & Remarks:
1) SPACE: Not an Investment Vehicle
MVCDAO wants to make it crystal clear: SPACE isn't a get-rich-quick scheme. MVCDAO emphasizes that Space is not an investment vehicle, but the gas within the MVC ecosystem. The value and price of SPACE may be influenced by utility demand of MVC network, there may be risks of price fluctuations. Participants are advised against purchasing SPACE for investment or speculative purposes.
Please note that MVCDAO does not make any commitments or guarantees regarding the price or value of SPACE. When holding SPACE, it should be used solely for participation in MVCDAO governance or utility purpose within the MVC network.
2) No Investment Advise:
This proposal is focused on enhancing the visibility and sustainability of the MVC network. It is important to that this proposal do not constitute investment advice. Participants and all members should refrain from interpreting it as such.
3) Conflict of interest declaration:
The author of this proposal has not received any commission.
Last updated