Removes docs directory #263
Conversation
There was a problem hiding this comment.
Looks good! We still have the old site that's connected: https://old-docs.openzeppelin.com/contracts-compact/0.0.1/ . I think we should create a docs branch then update the playbook on the old docs repo here like this:
- url: https://github.com/OpenZeppelin/compact-contracts
branches:
- docs-v*
start_path: docs
so it can fetch the last prerelease (as opposed to reading from HEAD as it is now). WDYT?
Also, I think we can remove the docs tasks in turbo.json. I just left a question and a small suggestion. Lastly, I'd create an issue since it's not a trivial change so we can track it in the project :)
| The online version of the Compact contracts documentation is maintained at [OpenZeppelin/docs](https://github.com/OpenZeppelin/docs). | ||
| It should mirror all documentation embedded within the contracts themselves with additional context and usage examples if applicable. | ||
| Pull requests in [OpenZeppelin/docs](https://github.com/OpenZeppelin/docs) should be linked to the corresponding pull request in this repo. | ||
|
|
There was a problem hiding this comment.
Sooooooooooooo this adds a ton of friction for contributors. It's a good idea to have some coordination with linking a PR from the docs repo as you mentioned; however, this feels messy. The consequences of centralization :(
I was considering if we could place the docs repo in a submodule or subtree so all changes are, from the contributor's perspective, from the same project. The former is a bit more convenient for the contributor but they need to know how to work with submodules. The latter adds complexity to us but improves dx for the contributor...or keep it as-is. Thoughts?
There was a problem hiding this comment.
Totally agree, I think we can make this easier on contributors by using Git subtrees. I can add some scripts and more info to CONTRIBUTING.md to standardize the workflow.
| "scripts": { | ||
| "docs": "turbo run docs --filter=docs", | ||
| "docs:watch": "turbo run docs:watch --filter=docs", | ||
| "compact": "turbo run compact --filter=@openzeppelin-compact/contracts --log-prefix=none", | ||
| "build": "turbo run build --filter=!'docs' --log-prefix=none", |
There was a problem hiding this comment.
We can remove --filter=!'docs' in build
Removes docs directory since we're now maintaining our online docs at OpenZepplin/docs. Updates GUIDELINES and CONTRIBUTING files
Closes #265