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

Move Documentation to zkSnacks/WasabiDoc #2067

Closed
MaxHillebrand opened this issue Aug 3, 2019 · 3 comments

Comments

@MaxHillebrand
Copy link
Collaborator

commented Aug 3, 2019

Over the last couple blocks we have build the separate documentation repository zkSnacks/WasabiDoc and this is deployed at docs.wassabiwallet.io.

This means that the main WalletWasabi repo is clean and not cluttered with unnecessary documentation files and contributions. The work flow and review process of the maintainers is also different.

We are ready to move the main focus of documentation now from the main repo, to the separate repo. To ensure a proper migration, there is the following process:

  • A new PRs remove the content of one file each, and adds a link to the docs.wasabiwallet.io website documentation.
  • If one file should remain in the repo, simply close and do not merge the PR.
  • Although old links are thus not broken, we should start shilling the new website from now on.
  • Any further contributions will be directly to this new docs repo.

#2051 & #2052 & #2053 & #2054 & #2055 & #2056 & #2057 & #2058 & #2059 & #2060 & #2061 & #2062 & #2063 & #2064 & #2065 & #2066

@MaxHillebrand

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 7, 2019

Many of the above got merged, yet some important main repo files, like #2066 [I agree with not moving this], and maintainer specific files like #2053 #2054 #2065 are closed.

I do think that because the building-wasabi pillar is made specifically for contributors, and maintainers, that it is good to merge the last three as well.

@MaxHillebrand

This comment has been minimized.

Copy link
Collaborator Author

commented Aug 9, 2019

Ok, I think all is discussed, most files are moved, those that are left behind are done so deliberately.

Closing the issue now!

From now on, please get used to link to docs.wasabiwallet.io

@johnnyasantoss

This comment has been minimized.

Copy link

commented Aug 16, 2019

@MaxHillebrand Hey! What about adding a heading to the README for people that want to contribute for them to find these new docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.