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

Deprecate the wiki in favour of in-tree documentation #1309

Open
Half-Shot opened this issue May 9, 2021 · 3 comments
Open

Deprecate the wiki in favour of in-tree documentation #1309

Half-Shot opened this issue May 9, 2021 · 3 comments
Labels
T-Documentation Improvements or additions to documentation

Comments

@Half-Shot
Copy link
Contributor

We're going to be freezing the wiki going forward in favour of the documentation hosted in the git tree.

The reasons for doing so are that we favour the ability to:

  • Review changes to the documentation so that we can verify accuracy before it is published.
  • Ensure that documentation is tied to a version, rather than it potentially falling out of date.
  • Give the team more control over the presentation of the documentation e.g. mdbook has a much nicer search interface.
  • Inline documentation with released versions of the code, so that users may look up docs simply by reading from the docs/*.md area.

The wiki won't be going anywhere for the time being as the new documentation is not complete, but any new changes should now be made to the documentation. As maintainers, we will be trying to quickly get the new documentation up to speed.

Thanks for your patience and help!

@Mikaela
Copy link
Contributor

Mikaela commented Aug 4, 2021

What is the new location for https://github.com/matrix-org/matrix-appservice-irc/wiki/End-user-FAQ particularly using NickServ from Matrix which regularly comes up?

Mikaela added a commit to Mikaela/mikaela.github.io that referenced this issue Aug 4, 2021
These two pages appear to have replacement in the in-tree documentation
while some others are still missing.

Ref: matrix-org/matrix.to#24
Ref: matrix-org/matrix-appservice-irc#1309
@Half-Shot
Copy link
Contributor Author

@Mikaela We're moving away from a "FAQ" style document as it ends up being an unorganised list of headings. The current equivalent is https://matrix-org.github.io/matrix-appservice-irc/latest/usage.html (for your particular example https://matrix-org.github.io/matrix-appservice-irc/latest/usage.html#authentication).

If you think our text isn't good enough, feel free to adjust it via PR :).

@Mikaela
Copy link
Contributor

Mikaela commented Aug 18, 2021

I do think so. The section you link me to says that there is a !username command, it doesn't tell me how do I also specify a password which is documented a couple of sections up in "customizing your IRC experience" which will fail whenever the nickname is already in use during connection as there is no mention of storing username: as the beginning of the password. There is also no hint that the !username and !storepass work together.

I have no idea how to start fixing it.

@justinbot justinbot added T-Documentation Improvements or additions to documentation and removed docs labels May 13, 2022
@Half-Shot Half-Shot unpinned this issue May 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants