Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create proper documentation and tutorials #52

Open
nptr opened this issue May 14, 2021 · 0 comments
Open

Create proper documentation and tutorials #52

nptr opened this issue May 14, 2021 · 0 comments

Comments

@nptr
Copy link
Owner

nptr commented May 14, 2021

Over the years the tool has gained a small user base and help requests keep coming in. It's not a lot, but I still think it is time for some documentation and tutorials to help new or infrequent users. This issue shall serve the purpose of tracking and organizing the progress.

I am aiming for a web based documentation, probably hosted used github pages or using the wiki functionality. For structure, I'd go with a location map kind of style. Each chapter shows a screenshot of an important object with all the known parts highlighted.
I suppose a rough overview is enough for the intelligent user to find its way and figure out a solution to the specific problem.

Chapter Subchapter Status
Introduction hardly any
Basic Concepts Visual Styles okay
Common Controls okay
Window Frames basic
Explorer basic
Desktop todo

When time allows, I'll add more information and examples how I imagine the documentation. To contribute, please

  • create a comment here
  • attach a screenshot of the object in question
  • highlight and numerate its parts
  • provide the "paths" in msstyleEditor like Button > CHECKBOX > UNCHECKEDDISABLE > TEXTCOLOR

I'll collect and polish the provided snippets.

Update:
Find the basics here: https://github.com/nptr/msstyleEditor/wiki/Introduction
It's still very basic, but better then nothing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant