Skip to content

Commit

Permalink
feat: add changelog and introduction content
Browse files Browse the repository at this point in the history
  • Loading branch information
shiqimei committed Aug 21, 2023
1 parent 3538c98 commit 68e2e7d
Show file tree
Hide file tree
Showing 3 changed files with 121 additions and 22 deletions.
5 changes: 3 additions & 2 deletions pages/_meta.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"index": "Introduction",
"user": "User Guide",
"developer": "Developer Guide",
"android": "QuickJS Android"
"developer": "Subscriptions",
"android": "Blogs",
"changelog": "Changelog"
}
85 changes: 85 additions & 0 deletions pages/changelog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Change Log

All notable changes to the [AskCodebase AI](https://marketplace.visualstudio.com/items?itemName=JipitiAI.askcodebase) extension will be documented in this file.

## [0.33.0 (2023-08-17) 🥳](https://marketplace.visualstudio.com/items/JipitiAI.askcodebase/changelog)

### 🐛 Bug Fixes

1. Fix known issues

## [0.32.0 (2023-08-17) 🥳](https://marketplace.visualstudio.com/items/JipitiAI.askcodebase/changelog)

### 🎉 Features

1. Add `askcodebase.layout` to support customizing the layout

## [0.31.0 (2023-08-16) 🥳](https://marketplace.visualstudio.com/items/JipitiAI.askcodebase/changelog)

### 🧹 Chore

1. Fix known issues

## [0.30.0 (2023-08-15) 🥳](https://marketplace.visualstudio.com/items/JipitiAI.askcodebase/changelog)

### 🎉 Features

1. Improve login experience and make login more stable

## [0.29.0 (2023-08-15) 🥳](https://marketplace.visualstudio.com/items/JipitiAI.askcodebase/changelog)

### 🎉 Features

1. Support <kbd>Commnad/Ctrl + P</kbd> to open `quickOpen` in AskCodebase input directly

### 🐛 Bug Fixes

1. Fix `Enter` to unexpectedly send message when suggestion popup is active.

## [0.28.0 (2023-08-14) 🥳](https://marketplace.visualstudio.com/items/JipitiAI.askcodebase/changelog)

### 🐛 Bug Fixes

1. Fix wrong padding in WelcomeScreen examples component

## [0.19.0 (2023-08-11) 🥳](https://marketplace.visualstudio.com/items/JipitiAI.askcodebase/changelog)

### 🧹 Chore

1. Update README.md
2. Delay `Open Walkthrough` after extension was updated

## [0.18.0 (2023-08-11) 🥳](https://marketplace.visualstudio.com/items/JipitiAI.askcodebase/changelog)

### 🎉 Walkthrough

We introduced Walkthrough feature since version 0.18.0 with 4 steps:

1. `What's New` Get to know our latest features to improve your productivity.
2. `Open AskCodebase` Click "Open Askcodebase" button in the status bar to open AskCodebase AI panel.
3. `Select Layout` Choose your favorite layout to use AskCodebase AI in VSCode comfortablely.
4. `Join Discord Community` Join our discord community to report feedbacks and co-build the product.

### 🐛 Bug Fixes

Besides, we fixed some known issues to improve the stabilities of AskCodebase AI.

Hope you can enjoy it!

Free free to join our [discord server](https://discord.gg/5Ny6UuNKVD) to report report feedbacks and co-build the product with us.

## 0.17.0 (2023.08.10)

- Disable `local shell commands` supports for its not stable enough;
- Fixes ordered list and unordered list UI rendering bugs;
- Improve status bar item button text (Open AskCodebase / Hide AskCodebase)

## 0.15.0

- Support `clear` built-in command to clear messages
- Support hybrid input (Chat & Shell Commands)
- Long-term memory is supported (context)

## 0.1.0

- Initial release
53 changes: 33 additions & 20 deletions pages/index.mdx
Original file line number Diff line number Diff line change
@@ -1,41 +1,54 @@
# Introduction

Welcome to the OpenQuickJS Documentation!
> Programmars will not be replaced by AI, but those who don't use AI devtools will.
## Introducing OpenQuickJS: A Community-Driven Approach
### Introducing AskCodebase: You AI Programming Autopilot

OpenQuickJS is a community-driven fork of [QuickJS](https://bellard.org/quickjs/). We welcome and encourage issues and pull requests from all users.
#### Transition from Coding to Problem Solving

Our motivation for creating OpenQuickJS was due to the limited openness of the official QuickJS repository [bellard/quickjs](https://github.com/bellard/quickjs). We recognized that there were numerous exceptional [pull requests](https://github.com/bellard/quickjs/pulls), both open and closed, which deserved attention.
AskCodebase AI redefines the role of developers, enabling them to focus on high-level solution design and communicate with AI using natural language. It liberates developers from the intricacies of coding, allowing them to transition from traditional coding roles into solution designers and problem solvers.

OpenQuickJS provides us with a platform where we can take the time to review these pull requests and apply valuable patches to our version. Our approach to open source is guided by the following principles:
#### It's More Than Just an Auto-complete Tool

### Principles
[AskCodebase AI](https://marketplace.visualstudio.com/items?itemName=JipitiAI.askcodebase) isn’t about coding copilot, autocomplete, or code intellisense. It’s something deeper and more profound. This is about a tool that operates at a **task level**, aimed at taking over the mundane, foundational, and repetitive tasks that often suck the joy out of programming. It’s not just about suggesting or filling in gaps; it’s about comprehensively handling the grunt work and bringing back the joy of problem solving in programming.

#### 1. Embracing Modern Contribution Methods
Want to learn more about our vision and why we built AskCodebase AI? Read this article [Of Late Nights and Endless Lines of Code: Is There a Better Way?](https://medium.com/p/49bc958da10d) written by our CEO - Shiqi.

The original QuickJS repository does not accept pull requests, instead favoring a mailing list system that can be challenging for modern contributors. OpenQuickJS, on the other hand, readily accepts pull requests, making it more accessible for community involvement.
#### Meet Jipiti AI: The Company Behind AskCodebase

#### 2. Supporting Modern Build Tools
[Jipiti AI](https://www.linkedin.com/company/jipitiai) is at the forefront of conversational programming powered by AI (especially LLM). We're building next-generation devtools to boost developers' productivity and happiness.

The original QuickJS repository does not support `CMakeLists.txt`. At OpenQuickJS, we acknowledge that **cmake** and **ninja** are modern build tools that should be embraced. We have therefore made it a point to accept `CMakeLists.txt`.
### AskCodebase Principles

#### 3. Ensuring Transparency
#### Tasks, not autocomplete

We believe in complete transparency, which is why every commit and modification is tracked in the git history and is available for all users to view.
We believe that developers should focus on the bigger picture - designing and delivering effective solutions. That's why AskCodebase AI focuses on understanding and implementing tasks, rather than merely aiding with code completion. Our AI digs deep into the problem you're trying to solve and constructs the necessary code to accomplish the task, leaving you more time to conceptualize and innovate.

#### 4. Providing Comprehensive Documentation
#### Conversations, not commands

We offer comprehensive documentation to guide new users. Whether you're here to use the project or to contribute to its development, our documentation will provide you with the guidance you need.
Coding should not be a one-way street. That's why AskCodebase AI is designed to engage with you. We have built a platform that promotes two-way communication, where you can have meaningful conversations with the AI about the task at hand. This approach not only makes the programming experience more enjoyable but also ensures the quality and effectiveness of the code being produced.

#### 5. Prioritizing Code Maintainability
#### Requirements, not code

OpenQuickJS places a high priority on code maintainability. Unlike the original QuickJS repository, which tends to place large amounts of code within a single C file, OpenQuickJS opts for a well-organized code structure where each section of code has its own dedicated area. This approach not only makes the codebase easier to navigate, but also simplifies the process of maintaining and updating the code.
In programming, understanding the requirements is half the battle. If an AI just churns out code without understanding the underlying requirements, the code will likely miss the mark. AskCodebase AI takes a requirements-first approach, where it seeks to understand the requirements of the task before generating code. This ensures that the resulting code is not just syntactically correct, but semantically accurate and useful as well.

## Acknowledgements

We would like to take a moment to express our deep gratitude towards [Fabrice Bellard](https://bellard.org/), the creator of the original QuickJS. His tremendous work in creating QuickJS has brought an exceptional JavaScript engine to the world, serving as the foundation upon which OpenQuickJS is built.
In a nutshell, AskCodebase AI is not just about coding - it's about understanding your needs, engaging with you, and delivering effective solutions. Whether you're a seasoned developer or a novice just getting started, AskCodebase AI is here to make your coding experience more productive, meaningful, and enjoyable.

While our project is a fork designed to address certain limitations we perceived in the original [QuickJS](https://bellard.org/quickjs/) repository, we maintain the utmost respect for Bellard's work and contributions to the field. His innovation and dedication continue to inspire us as we work to improve and expand upon QuickJS in our own way through OpenQuickJS.
#### Efficiency, not just speed

To Bellard, and to all who have contributed to QuickJS, we say: thank you!
Speed is crucial in programming, but efficiency is even more important. AskCodebase AI prioritizes achieving tasks in the most resource-efficient manner, reducing the need for redundant code and ensuring that the end result is as streamlined and effective as possible.

#### Learning, not just doing

AskCodebase AI doesn't just perform tasks; it also learns your coding style and preferences over time. This allows it to provide more personalized and accurate assistance, making your programming experience smoother and more enjoyable.

#### Collaboration, not isolation

Programming should not be a solitary endeavor. AskCodebase AI is designed to work as part of your team, allowing for seamless collaboration between human programmers and AI. This collaboration ensures that the final product is the result of a combined effort, leveraging the strengths of both man and machine.

#### Innovation, not replication

While AskCodebase AI can help with repetitive tasks, it's not just about copying and pasting existing code. The AI aims to innovate and suggest different approaches where appropriate, pushing the boundaries of what's possible in programming.

Through these principles, AskCodebase AI provides a unique and powerful tool that will revolutionize the way programming is done, making it more efficient, enjoyable and innovative.

0 comments on commit 68e2e7d

Please sign in to comment.