Skip to content

Commit 65ff8f6

Browse files
committed
refine project documentation for clarity and consistency across AstraKernel, CodeAstra, DevLog, and index pages
1 parent 056792e commit 65ff8f6

File tree

4 files changed

+14
-53
lines changed

4 files changed

+14
-53
lines changed

website/projects/astrakernel.md

Lines changed: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ title: AstraKernel
44

55
# AstraKernel ~ A minimal ARM kernel for QEMU
66

7-
AstraKernel is a minimal experimental kernel written in C and ARM assembly, designed to run on
8-
QEMU's VersatilePB (ARM926E) emulated platform. This project currently
7+
AstraKernel is a minimal experimental kernel written in modern C and ARM assembly, designed to run on
8+
**QEMU's VersatilePB (ARM926E)** emulated platform. This project currently
99
demonstrates how to bootstrap a system, set up the stack, zero the `.bss`
1010
section, and perform basic UART output (printing text to the serial console).
1111

@@ -28,41 +28,9 @@ Type away, explore, have fun.
2828
- Memory-mapped UART output for terminal messages
2929
- Runs under QEMU
3030

31-
## Building
32-
33-
### Native Build
34-
35-
Make sure you have an ARM cross-compiler installed (e.g., `arm-none-eabi-gcc`) and `qemu-system-arm`.
36-
37-
```sh
38-
make
39-
```
40-
41-
<Badge type="tip" text="Important" />
42-
43-
> `make` will clean, build, and run the kernel in QEMU. You can also run
44-
`make qemu` to run the kernel without cleaning or building it again.
45-
46-
### Docker Build
47-
48-
If you have docker installed, you can also run AstraKernel through a docker container:
49-
50-
```sh
51-
make docker
52-
```
53-
54-
<Badge type="tip" text="Important" />
55-
56-
> `make docker` will pull from the most recent `main` commit from the upstream repository
57-
> `https://github.com/sanbox-science/AstraKernel.git`.
58-
> If you wish to use a local copy, you can run `make docker-dev`, which will copy all
59-
> local build files into the repository.
60-
6131
## Documentation
6232

6333
For more details about this kernel, refer to the [AstraKernel Documentation](https://github.com/sandbox-science/AstraKernel/blob/main/doc/AstraKernelManual.pdf).
6434

65-
<Badge type="info" text="Note" />
66-
67-
> The manual is a work in progress and may not cover all features yet.
35+
> <Badge type="info" text="Note" /> The manual is a work in progress and may not cover all features yet.
6836

website/projects/codeastra.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,11 @@ title: CodeAstra
77

88
<h1 align="center">CodeAstra ~ Modern Code Editor</h1>
99

10-
CodeAstra is a modern, extensible, and lightweight code editor built using C++ and Qt6, designed to offer a fast, customizable, and feature-rich development experience. Inspired by NeoVim and VSCode, it **will** provide efficient file navigation, syntax highlighting, and a powerful plugin system, making it an ideal choice for developers who need speed, flexibility, and control. With a focus on performance and usability, the editor **will** support split views, an integrated terminal, customizable key bindings, and seamless Git integration, catering to both beginners and power users.
10+
CodeAstra is a modern, extensible, and lightweight code editor built using modern C++ and Qt6, designed to offer a fast, customizable, and feature-rich development experience. Inspired by NeoVim and VSCode, it provide an efficient file navigation, syntax highlighting, and potentically a powerful plugin system, making it an ideal choice for developers who need speed, flexibility, and control. With a focus on performance and usability, the editor **will** support split views, an integrated terminal, customizable key bindings, and seamless Git integration, catering to both beginners and power users.
1111

12-
<Badge type="info" text="Note" />
12+
> <Badge type="info" text="Note" /> CodeAstra is **under active development**. Stay tuned for updates or feel free to contribute and help shape its future!
1313
14-
> CodeAstra is **under active development**. Stay tuned for updates or feel free to contribute and help shape its future!
15-
16-
<Badge type="tip" text="Important" />
17-
18-
> CodeAstra has been tested on macOS and Linux and works as expected on those platforms. The project has not been tested natively on Windows, but it works when using **WSL** (Windows Subsystem for Linux). Native Windows support is not guaranteed.
14+
> <Badge type="tip" text="Important" /> CodeAstra has been tested on macOS and Linux and works as expected on those platforms. The project has not been tested natively on Windows, but it works when using **WSL** (Windows Subsystem for Linux). Native Windows support is not guaranteed.
1915
2016
## How to install the project
2117
Please, check the [wiki](https://github.com/sandbox-science/CodeAstra/wiki) for recommended installation instructions.
@@ -25,3 +21,5 @@ Please, check the [wiki](https://github.com/sandbox-science/CodeAstra/wiki) for
2521
- Make
2622
- g++ compiler (with support of C++20 and beyond)
2723
- Qt6 Framework
24+
25+
**Repository**: https://github.com/sandbox-science/CodeAstra

website/projects/devlog.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,12 @@ title: DevLog
1616
```
1717
**DevLog** is a lightweight CLI tool that records your local development workflow. It captures notes, shell activity, and Git actions to produce a structured, timestamped report, perfect for debugging, documentation, or reflection. The logs are recorded in text format via a JSON file. The tool can generate a Markdown and HTML report for developers to directly visualize their workflow offline directly from their browser.
1818

19-
<Badge type="tip" text="Note" />
20-
>
21-
> More about the idea on this [article](https://listed.to/@Astra/63832/devlog-cli-developer-tool).
22-
23-
---
19+
> <Badge type="tip" text="Note" /> More about the idea on this [article](https://listed.to/@Astra/63832/devlog-cli-developer-tool).
2420
2521
## Features
2622

2723
- 📋 Start and stop sessions via DevLog shell
2824
- 📝 Add timestamped notes during a session
29-
- 🎟️ Add timestamped git activity during a session
30-
- 📂 Export sessions as Markdown and HTML logs
25+
- 🎟️ Auto log timestamped git activity during a session
26+
- 📂 Export sessions as Markdown and HTML logs for friendly visual
3127
- 📁 Organized logs stored in `~/.devlog/sessions/`
32-

website/projects/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ title: Projects
55
# 🚀 Projects
66

77
Welcome to the **Sandbox Science Projects** section!
8-
Here you’ll find our open-source experiments, tools, and collaborative builds.
8+
Here you’ll find our collaborative open-source experiments.
99

1010
## 🤝 How to Contribute
1111
We love contributions! Whether it’s a small fix or a big feature:
12-
1. Fork a project
12+
1. Fork one of our project
1313
2. Create your feature branch
1414
3. Submit a pull request
1515

16-
---
16+
> <Badge type="tip" text="Idea" /> Got a project idea? Pitch it, and let's build it!.
1717
1818
## 📚 Resources
1919
- [GitHub Organization](https://github.com/sandbox-science)

0 commit comments

Comments
 (0)