Skip to content

AkcentG/akcent-docs

Repository files navigation

📘 Akcent Docs

Community-maintained documentation for Restaurant Tycoon 3 Wiki editors.

🌐 Website https://akcent-docs.pages.dev

📂 GitHub https://github.com/AkcentG/akcent-docs

Features

  • Beginner-friendly editing guides
  • Wikitext reference library
  • Tips & Tricks
  • Useful Links
  • Community resources
  • Open source

🌟 About

Akcent Docs is a community-driven documentation website designed to help editors of the Restaurant Tycoon 3 Wiki.

Whether you're making your first edit or maintaining large sections of the wiki, Akcent Docs provides tutorials, references, examples, and resources to make editing easier and more approachable.

The project is built with Astro and Starlight, with a focus on clear writing, practical examples, and long-term maintainability.


✨ Features

  • 📘 Beginner-friendly guides
  • ⚡ Quick Start tutorial
  • 💡 Tips & Tricks
  • ❓ Questions & Answers
  • 🔗 Useful Links directory
  • 📚 Reference Library
  • ❤️ Community-focused project
  • 🌙 Dark mode support
  • 🔍 Built-in documentation search
  • 📱 Responsive design

🖼 Preview

A homepage screenshot will be added here in a future release.


📂 Documentation

Akcent Docs currently includes:

  • 📖 Introduction
  • ⚡ Quick Start
  • 💡 Tips & Tricks
  • ❓ Questions & Answers
  • 🔗 Useful Links
  • 📚 Reference Library
  • ℹ️ About
  • 📬 Contact
  • ❤️ Credits
  • ⚠️ Disclaimer

🚀 Getting Started

Clone the repository:

git clone https://github.com/AkcentG/akcent-docs.git

Navigate to the project:

cd akcent-docs

Install dependencies:

npm install

Start the development server:

npm run dev

Open your browser and visit:

http://localhost:4321

🛠 Built With

  • Astro
  • Starlight
  • Markdown
  • MDX
  • TypeScript
  • CSS

📁 Project Structure

src/
├── assets/
├── content/
│   └── docs/
├── styles/
└── components/

public/

.github/

README.md
CONTRIBUTING.md
CHANGELOG.md
LICENSE

🤝 Contributing

Contributions are always welcome.

You can help by:

  • Reporting issues
  • Fixing documentation
  • Suggesting improvements
  • Adding new guides
  • Sharing useful resources

Please read CONTRIBUTING.md before submitting a pull request.


🛣 Roadmap

✅ Completed

  • Project setup
  • Website branding
  • Documentation structure
  • Homepage redesign
  • Navigation improvements
  • Core documentation
  • Repository setup

🚧 In Progress

  • Design system
  • UI polish
  • Screenshots and visual guides
  • Documentation components

🔮 Future Plans

  • Advanced wiki editing guides
  • Interactive examples
  • Expanded reference library
  • Community contributions
  • Public release

❤️ Credits

Created and maintained by Akcent.

Special thanks to the Restaurant Tycoon 3 Wiki community and everyone who shared their knowledge, feedback, examples, and documentation resources that helped shape this project.


⚠️ Disclaimer

Akcent Docs is an independent fan project.

It is not affiliated with, endorsed by, or associated with Restaurant Tycoon 3, Ultra Games Entertainment, or the official Restaurant Tycoon 3 Wiki.


📜 License

This project is licensed under the MIT License.

See the LICENSE file for more information.

About

Community-maintained documentation for Restaurant Tycoon 3 Wiki editors.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages