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

Centralize documentation for nearcore devlopers #5079

Closed
matklad opened this issue Oct 25, 2021 · 8 comments
Closed

Centralize documentation for nearcore devlopers #5079

matklad opened this issue Oct 25, 2021 · 8 comments
Labels
C-docs Category: documentation, including rustdoc, nomicon, and docs.nearprotocol.com C-housekeeping Category: Refactoring, cleanups, code quality T-core Team: issues relevant to the core team

Comments

@matklad
Copy link
Contributor

matklad commented Oct 25, 2021

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.

@matklad matklad added C-housekeeping Category: Refactoring, cleanups, code quality C-docs Category: documentation, including rustdoc, nomicon, and docs.nearprotocol.com T-core Team: issues relevant to the core team labels Oct 25, 2021
@bowenwang1996
Copy link
Collaborator

Assuming that the purpose of having nearcore dev docs at docs.near.org is to funnel contract developers into nearcore

I am not sure that is the intention. Contract developers usually don't care about how nearcore works.

@matklad
Copy link
Contributor Author

matklad commented Oct 25, 2021

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?

@bowenwang1996
Copy link
Collaborator

how to, eg, speed up the build process, should live in this repository.

Good point. We should definitely fix that

@Rishabhraghwendra18
Copy link
Contributor

Hi @bowenwang1996 . I will like to work on this issue

@bowenwang1996
Copy link
Collaborator

@Rishabhraghwendra18 feel free to submit a PR!

@Rishabhraghwendra18
Copy link
Contributor

@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.

@stale
Copy link

stale bot commented Mar 26, 2022

This issue has been automatically marked as stale because it has not had recent activity in the last 2 months.
It will be closed in 7 days if no further activity occurs.
Thank you for your contributions.

@stale stale bot added the S-stale label Mar 26, 2022
@akhi3030 akhi3030 removed the S-stale label Jul 8, 2022
@matklad
Copy link
Contributor Author

matklad commented Nov 21, 2022

superceeded by #7670 and mostly fixed at this point

@matklad matklad closed this as completed Nov 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-docs Category: documentation, including rustdoc, nomicon, and docs.nearprotocol.com C-housekeeping Category: Refactoring, cleanups, code quality T-core Team: issues relevant to the core team
Projects
None yet
Development

No branches or pull requests

4 participants