-
Notifications
You must be signed in to change notification settings - Fork 670
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
Centralize documentation for nearcore devlopers #5079
Comments
I am not sure that is the intention. Contract developers usually don't care about how nearcore works. |
Yeah, I guess I should have been more explicit here. To me, it's very obvious that documentation for how to, eg, speed up the build process, should live in this repository. So, I am wondering if I am missing any motivation for not doing that? |
Good point. We should definitely fix that |
Hi @bowenwang1996 . I will like to work on this issue |
@Rishabhraghwendra18 feel free to submit a PR! |
@bowenwang1996 I have opened an issue in the repo regarding setting Up the local development environment few days back , see #5735 . It will also have the instructions to build the repo so do we include same those steps here too ? If we did then I think we need to update the same steps at two places if our setting up environment steps change. |
This issue has been automatically marked as stale because it has not had recent activity in the last 2 months. |
superceeded by #7670 and mostly fixed at this point |
Today we have https://docs.near.org/docs/community/contribute/contribute-nearcore and https://github.com/near/nearcore/blob/master/CONTRIBUTING.md with duplicated content. I feel we should have single-source-of-truth here.
Assuming that the purpose of having nearcore dev docs at docs.near.org is to funnel contract developers into nearcore, I think we should re-target docs there to be pointers into the docs in the repo. Ie, at https://docs.near.org/docs/community/contribute/contribute-nearcore it makes sense to talk about good-first-issues, getting rust installed and the overall process of creating a github pull request. It doesn't make sense to explain how to speed up compile times or how to enable logging – that detailed info should be moved into this repository.
The text was updated successfully, but these errors were encountered: