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

Enable wiki on fteqw repo #224

Open
hemebond opened this issue Sep 26, 2023 · 4 comments
Open

Enable wiki on fteqw repo #224

hemebond opened this issue Sep 26, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested

Comments

@hemebond
Copy link

Enabling the wiki on the repo would allow us to provide more documentation for FTE QC extensions and functions, beyond the one line comments dumped to the defs file.

@eukara
Copy link
Contributor

eukara commented Sep 26, 2023

FTEQW has its very own section on QuakeWiki, and people can contribute details to extensions/builtins on this page here

@hemebond
Copy link
Author

I feel it would be better to have the documentation/tutorials with the project/code. Feel free to close if you prefer people use QuakeWiki.

@Xylemon Xylemon added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested labels Sep 27, 2023
@Xylemon
Copy link
Collaborator

Xylemon commented Sep 28, 2023

As for my two cents on the issue:

I agree the documentation situation with FTE has never been great and really scattered. @Shpoike had a wiki on triptohell.info (FTE's old site), there is the "unofficial" yet semi-official FTE section on quakewiki.org, @eukara has some great FTEQCC stuff documented on his personal site, and we have some basic (WIP) documentation we will soon be committing inside the repo.

I think including some documentation inside the repo is going to be a good step, and while the idea of a git based wiki is appealing we also mirror and host on a Gitea and I don't know how cross compatible that is with Github's wiki system. I also would like to help out quakewiki.org, as I think it is a great open alternative to Fandom, but perhaps it should just be a companion wiki.

Overall there is just a lot to maintain, there's a lot of options, and we sadly haven't had the time for it. I'd like to hear @Shpoike thoughts as well as what the community would find the most sensible approach.

@Shpoike
Copy link
Contributor

Shpoike commented Oct 15, 2023

there's some technical stuff in fte's specs/ dir and noone's ever asked me about it so I don't think anyone really cares.
what people really seem to want are examples and samples, which they can just copypasta without having to understand at all, or in other words mods that actually use this stuff. fte desn't necessarily need a wiki of its own, but it does need an updated readme file that provides some links to clean examples that people can actually learn from (or at least navigate easily enough to copypasta from).

I still need to kill/disable the wiki on qss's repo. :s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested
Projects
None yet
Development

No branches or pull requests

4 participants