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

Documentation #61

Open
fmahnke opened this issue Oct 21, 2023 · 1 comment
Open

Documentation #61

fmahnke opened this issue Oct 21, 2023 · 1 comment
Labels
contribution request enhancement New feature or request good first issue Good for newcomers

Comments

@fmahnke
Copy link
Contributor

fmahnke commented Oct 21, 2023

Do we have a community documentation effort somewhere besides the git repo? If not, could we start a github wiki for VXT? There's a growing list of nice features, but I think some people may move on because they overlook them or can't figure out how to use them.

Documentation of the VXT_ environment variables would be interesting for anyone who wants to build and run from source. Documenting usage and creation of Lua modules and the GDB stub would be helpful for developers and power users.

When I want to do something new with VXT, I usually have to read its source code or ask in the issue tracker. These things don't bother me, so I wait until I have the time and then I do them and try to keep notes on how things work. Most end users won't even know how to read the code, though, so it would be good to have a place to put our knowledge that helps newcomers get started.

@andreas-jonsson
Copy link
Owner

There was a manual once. But it was very thin and it did nor survive the rewrite.

I can add a wiki but it likely depends on contributions. :)

@andreas-jonsson andreas-jonsson added enhancement New feature or request good first issue Good for newcomers contribution request labels Oct 21, 2023
@andreas-jonsson andreas-jonsson added this to the 1.0 milestone Nov 10, 2023
@andreas-jonsson andreas-jonsson removed this from the 1.0 milestone May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution request enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants