Request a doc perusal

Question

0.00/5 (No votes)

See more:

Having written my docs they are tough to proof-read myself but even more difficult to know how accessible they are.

I tried to keep them as brief as possible, and include a lot of code, because my previous attempt with my companion library took a different, more traditional tack and hasn't gotten a lot of traction.

That being said, any C++ developers mind giving these a look and telling me if they are intelligible?

I know there are probably still proof errors, and I could use a copy editor to follow me around. ha! but I'm more interested in how approachable my docs are.

uix/docs/index.md at master · codewitch-honey-crisis/uix · GitHub[^]

What I have tried:

uix/docs/index.md at master · codewitch-honey-crisis/uix · GitHub[^]

Posted 28-Aug-23 22:32pm

honey the codewitch

Add a Solution

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Richard MacCutchan · Accepted Answer · 2023-08-29T00:33:00

Solution 1

QA is really not the place for such questions. You should try Collaboration / Beta Testing Discussion Boards[^].

Posted 29-Aug-23 0:33am

Richard MacCutchan

Comments

honey the codewitch 29-Aug-23 9:03am

sorry! didn't know

Richard MacCutchan 29-Aug-23 9:10am

Navigating here is not always easy. Especially for people (you) who spend most of their time actually turning out finished products.