Skip to content

Commit

Permalink
build: Update docs to reference CDN image links to show up in NPM rea…
Browse files Browse the repository at this point in the history
…dme.
  • Loading branch information
mmiscool committed Jan 5, 2025
1 parent aa3e37e commit 0515ad7
Show file tree
Hide file tree
Showing 8 changed files with 1,562 additions and 311 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ With **aiCoder** as your coding co-pilot, you can simplify development, refine y
The magic lies in aiCoder’s advanced merging logic, which keeps your original code intact while integrating new snippets precisely and reliably.


![NEW UI](./docs/aiCoder.gif)
![NEW UI](https://aicoderproject.com/aiCoder.gif)

[Slide Deck discussing the AST approach to merging snippets](https://docs.google.com/presentation/d/1xdX09ELgW7lMU1E9KWIrpibUYVT1wdaiSvUhFhAT7EI/edit?usp=sharing)

[Code manipulator source file](./src/intelligentMerge.js)
[Code manipulator source file](./src/mergeTools/languages/javascript/javascript.js)



Expand Down Expand Up @@ -77,7 +77,7 @@ Then open [http://localhost:3000](http://localhost:3000/) in your browser to beg
To run on a different port use `aicoder -p 3001`

## Chat Interface
![NEW UI](./docs/CHAT.png)
![NEW UI](https://aicoderproject.com/CHAT.png)

## aiCoder provides two different specialized chat modes:

Expand All @@ -90,7 +90,7 @@ Begin by describing your project goals. You can ask the LLM to produce a detaile


# Tools
![NEW TOOLS](./docs/TOOLS.png)
![NEW TOOLS](https://aicoderproject.com/TOOLS.png)

## Methods List
Displays all detected methods.
Expand All @@ -103,7 +103,7 @@ Clicking on a method passes it into a new chat, allowing you to modify or implem

## Merge and Format
If you’re using ChatGPT or another external LLM, you can copy and paste suggested snippets to the end of the file. They must follow the guidelines in `snippet_production_prompt.md` for automatic merging.
![NEW TOOLS](./docs/TOOLS-AUTOMERGE.png)
![NEW TOOLS](https://aicoderproject.com/TOOLS-AUTOMERGE.png)

You can also just past your snippet in to the text area that appears when you click the merge and format button.

Expand All @@ -115,7 +115,7 @@ Project-specific settings are stored in `./.aiCoder/`. This folder includes back

You can customize system prompts for your project in the `./aiCoder/` folder. Access these settings in your IDE or from the **Project Settings** tab.

![NEW TOOLS](./docs/PROJECT-SETTINGS.png)
![NEW TOOLS](https://aicoderproject.com/PROJECT-SETTINGS.png)


## default_plan_prompt
Expand All @@ -137,7 +137,7 @@ class exampleClass {
```

# LLM Settings
![NEW LLM SETTINGS](./docs/SETTINGS.png)
![NEW LLM SETTINGS](https://aicoderproject.com/SETTINGS.png)

Before using aiCoder, configure your LLM provider and model. After providing an API key, you can view available models.

Expand Down
267 changes: 3 additions & 264 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,269 +26,7 @@
<link rel="icon" href="./logo.png" type="image/x-icon">

<title>aiCoder - AI-Powered Coding Assistant</title>
<style>
body {
font-family: 'Arial', sans-serif;
background-color: #121212;
color: #f1f1f1;
margin: 0;
padding: 0;
scroll-behavior: smooth;
transition-duration: 1s;
}

.background {
z-index: -1;
position: fixed;
top: 0;
left: 0;
bottom: 0;
right: 0;
background: rgb(2, 0, 36);
background: linear-gradient(165deg, rgb(71, 3, 54) 0%, rgba(0, 0, 0, 1) 25%, rgba(0, 0, 0, 1) 70%, rgba(0, 212, 255, 0.8297443977591037));
}

header {
background: #1f1f1f;
padding: 20px;
text-align: center;
position: sticky;
top: 0;
z-index: 1000;
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.5);
}

header h1 {
margin: 0;
font-size: 2.5em;
color: #00d1b2;
}

header nav a {
color: #f1f1f1;
text-decoration: none;
margin: 0 15px;
font-size: 1.1em;
transition: color 0.3s;
}

header nav a:hover {
color: #00d1b2;
}

.button-group {
display: flex;
justify-content: center;
}


section {
display: flex;
flex-wrap: wrap;
align-items: center;
padding: 40px 20px;
/* rounded corners */
border-radius: 8px;
}

section:nth-child(even) {
background: #1f1f1f77;
}

section:nth-child(odd) {
/*background: #121212;*/
}

section h2 {
font-size: 2em;
margin-bottom: 15px;
color: #00d1b2;
}

section p,
section ul li {
color: white;
line-height: 1.8;
margin-bottom: 10px;
}

.container {
width: 90%;
max-width: 1200px;
margin: auto;
}

.content {
flex: 1;
padding: 20px;
min-width: 300px;
}

.image-container {
flex: 1;
text-align: center;
margin: 20px;
box-sizing: border-box;
filter: drop-shadow(16px 16px rgba(0, 0, 0, 0.509));
}

.image-container img {
max-width: 100%;
border-radius: 8px;
}

.cta {
text-align: center;
color: #121212;
padding: 50px 20px;
border-radius: 8px;
}

.cta a {
background: #181818da;
color: #00d1b2;
padding: 12px 24px;
text-decoration: none;
border-radius: 5px;
font-weight: bold;
transition: background 0.3s, color 0.3s;
/* prevent text wrapping */
white-space: nowrap;
margin: 5px
}

.cta a:hover {
background: #00d1b2;
color: #121212;
}


#mergeButton {
background: #064448;
color: #00d1b2;
padding: 12px 24px;
text-decoration: none;
border-radius: 5px;
font-weight: bold;
transition: background 0.3s, color 0.3s;
/* prevent text wrapping */
white-space: nowrap;
margin: 5px;
width: 100%;
height: 50px;
text-align: center;

margin-left: 20%;
margin-right: 20%;

}

#mergeButton:hover {
background: #00d1b2;
color: #121212;
}

footer {
text-align: center;
padding: 20px;
background: #1f1f1f;
color: #777;
}

footer a {
color: #00d1b2;
text-decoration: none;
}

textarea {
background-color: rgb(0, 0, 0);
border-radius: 5px;
border-color: #00d1b2;
border-width: 3px;

justify-content: center;
padding: 10px;
height: 70px;
padding-right: 40px;
width: 250px;
overflow: hidden;
box-sizing: border-box;
color: #00d1b2;

}

button {
background-color: rgb(0, 0, 0);
border-radius: 5px;
border-color: #00d1b2;
border-width: 3px;
margin: 0px -30px;


box-sizing: border-box;
}

code {
background-color: black;
color: yellow;
padding: 5px;
border-radius: 5px;
/* preformatted text */
white-space: pre;
}


.github-corner {
z-index: 100000;
position: fixed;
right: 0px;
top: 0px;
}

.github-corner:hover .octo-arm {
animation: octocat-wave 560ms ease-in-out
}

@keyframes octocat-wave {

0%,
100% {
transform: rotate(0)
}

20%,
60% {
transform: rotate(-25deg)
}

40%,
80% {
transform: rotate(10deg)
}
}

@media (max-width:500px) {
.github-corner:hover .octo-arm {
animation: none
}

.github-corner .octo-arm {
animation: octocat-wave 560ms ease-in-out
}
}


.codeTextArea {
background-color: black;
color: yellow;
padding: 5px;
border-radius: 5px;
/* preformatted text */
white-space: pre;
width: 100%;
height: 350px;
}
</style>
<link rel="stylesheet" href="./style.css">
</head>

<body>
Expand Down Expand Up @@ -325,6 +63,7 @@ <h2>Ready to Revolutionize Your Coding?</h2>
<div class="button-group">
<a href="https://github.com/mmiscool/aiCoder" target="_blank">View on GitHub</a>
<a href="#installation">Install Now</a>
<a href="https://discord.gg/KuZZs2er49" target="_blank">Chat on Discord</a>
</div>
</div>

Expand Down Expand Up @@ -576,7 +315,7 @@ <h2>FAQs</h2>
and is still experimental.</li>
</li>
<li><strong>Can I help?</strong>
Sure. If folks are interested we can set up a discord server. If you are knowledgeable about how
Sure. If folks are interested lets chat on <a href="https://discord.gg/KuZZs2er49" target="_blank">discord.</a> If you are knowledgeable about how
LSPs and ASTs work it would be really great to chat.
</li>

Expand Down
Loading

0 comments on commit 0515ad7

Please sign in to comment.