[PR #232] [MERGED] Create new documentation site based on README #181

New issue

Closed

opened 2026-05-23 08:32:45 -06:00 by gitea-mirror · 0 comments

gitea-mirror commented

2026-05-23 08:32:45 -06:00

Owner

📋 Pull Request Information

Original PR: https://github.com/appy-one/acebase/pull/232
Author: @etekweb
Created: 6/15/2023
Status: ✅ Merged
Merged: 7/17/2023
Merged by: @appy-one

Base: master ← Head: master

📝 Commits (3)

5053c28 create documentation based on README
25bc12e add title/icon, dark theme option, copy btn for code
89adb40 Add img dir

📊 Changes

9 files changed (+2369 additions, -0 deletions)

View changed files

➕ docs/.nojekyll (+0 -0)
➕ docs/README.md (+2275 -0)
➕ docs/favicon.ico (+0 -0)
➕ docs/img/contribute.svg (+17 -0)
➕ docs/img/logo.png (+0 -0)
➕ docs/img/logo_no_bg.png (+0 -0)
➕ docs/img/sponsor.svg (+24 -0)
➕ docs/img/tweet.svg (+16 -0)
➕ docs/index.html (+37 -0)

📄 Description

Adds a new documentation site based on the current README.md file. This approach is much easier to navigate than the current docs since you can use the navigation bar on the left-hand side (as discussed in #95).

Note

To publish the documentation, a project maintainer will need to set up GitHub Pages to point to the docs/ folder in the repo. See here for instructions.

Future Development

After the documentation site is published, the main repo README.md file can then be dramatically simplified to just contain the basic project info and a link to the documentation site.

Also, it would probably be useful to ultimately divide the README file into multiple subpages. This will reduce the overall amount of information on first load, as well as simplifying future updates to the documentation.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/appy-one/acebase/pull/232 **Author:** [@etekweb](https://github.com/etekweb) **Created:** 6/15/2023 **Status:** ✅ Merged **Merged:** 7/17/2023 **Merged by:** [@appy-one](https://github.com/appy-one) **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (3) - [`5053c28`](https://github.com/appy-one/acebase/commit/5053c28aa85a6758ad883da69a4bab45ffaeafe4) create documentation based on README - [`25bc12e`](https://github.com/appy-one/acebase/commit/25bc12e00add6bfba082c9b8cdfe6b4ec69f8d46) add title/icon, dark theme option, copy btn for code - [`89adb40`](https://github.com/appy-one/acebase/commit/89adb40b28833f7405135b463dce0bfcedbcd4a2) Add img dir ### 📊 Changes **9 files changed** (+2369 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `docs/.nojekyll` (+0 -0) ➕ `docs/README.md` (+2275 -0) ➕ `docs/favicon.ico` (+0 -0) ➕ `docs/img/contribute.svg` (+17 -0) ➕ `docs/img/logo.png` (+0 -0) ➕ `docs/img/logo_no_bg.png` (+0 -0) ➕ `docs/img/sponsor.svg` (+24 -0) ➕ `docs/img/tweet.svg` (+16 -0) ➕ `docs/index.html` (+37 -0) </details> ### 📄 Description Adds a new documentation site based on the current README.md file. This approach is much easier to navigate than the current docs since you can use the navigation bar on the left-hand side (as discussed in #95). > **Note** > To publish the documentation, a project maintainer will need to set up GitHub Pages to point to the docs/ folder in the repo. [See here for instructions](https://docsify.js.org/#/deploy?id=github-pages). ## Future Development After the documentation site is published, the main repo README.md file can then be dramatically simplified to just contain the basic project info and a link to the documentation site. Also, it would probably be useful to ultimately divide the README file into multiple subpages. This will reduce the overall amount of information on first load, as well as simplifying future updates to the documentation. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>