aui-framework / aui-framework/aui

Proper Documentation for Beginners

Open
#404 33 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
598
Forks
44
Avg merge
17h 56m
Merged PRs (30d)
3

Description

I am writing detailed documentation for the end users of AUI, with the ultimate goal of achieving maximum developer friendliness.
Since the official documentation is somewhat scarce, I have started writing articles based on examples to document how to use AUI for specific tasks. My goal is to create an easy-to-read and understand guide that covers the entire AUI feature set within the next six months. This effort not only ensures that AUI becomes a practical choice for my future applications instead of Qt but also serves as a go-to guide for beginners. Thanks to @na2axl for helping me figure out certain macros.

I am attaching the first chapter of my documentation, which is still a work in progress. It will contain a [LibreOffice ODT file] for future edits and updates, allowing the community to contribute and improve it collaboratively.

[Our First AUI Application.odt](https://github.com/user-attachments/files/18240976/Our.First.AUI.Application.odt)
[Our First AUI Application.pdf](https://github.com/user-attachments/files/18240978/Our.First.AUI.Application.pdf)

So far i have figure out
=> Clickable Buttons
=> Check Boxes
=> Radio Buttons
=> Combo Boxes [Done]
=> Text Field
=> List View

Chapters on the above GUI elements will be added within the next week. I still have many other things to figure out, and hopefully, I will get some help along the way. Regardless, the plan is to prevent others—including myself, given my less-than-perfect memory—from going through the same trials and errors I experienced.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the attached “Our First AUI Application.odt” and PDF, then compare the first chapter with the listed GUI elements: buttons, check boxes, radio buttons, combo boxes, text fields, and list views. Done means producing an agreed, maintainable beginner guide covering a defined subset of these topics; the issue does not specify the repository location or a concrete documentation scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
desktop, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.