8000 docs: Update README and other documentation for new name · Issue #15 · cometbft/cometbft-db · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: Update README and other documentation for new name #15

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.

Sign up for GitHub

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

Jump to bottom
Closed
Tracked by #7
thanethomson opened this issue Jan 12, 2023 · 3 comments · Fixed by #26
Closed
Tracked by #7

docs: Update README and other documentation for new name #15

thanethomson opened this issue Jan 12, 2023 · 3 comments · Fixed by #26
Assignees
@thanethomson
Labels
documentation Improvements or additions to documentation rename Renaming our fork

Comments

@thanethomson
Copy link
Contributor
thanethomson commented Jan 12, 2023 •
edited
Loading

We need to update the README to remove all Tendermint-related references. Some aspects of the README won't work until we make this repo public, so we may need some follow-up work here then.
@thanethomson thanethomson mentioned this issue Jan 12, 2023
Closed
7 tasks
@thanethomson thanethomson added the documentation Improvements or additions to documentation label Jan 12, 2023
@andynog
Copy link
Contributor
andynog commented Jan 13, 2023

Just for clarification, when you say Tendermint-related references you're not just talking about renaming the word Tendermint but also any references to documentation for example ?

That's an interesting point, what is the proposed solution for links from the repo to documentation ? Assuming the current documentation will still be the Tendermint one (not sure we have an issue already for renaming/updating docs).

@jmalicevic
Copy link
Contributor

That's a good point. There is an issue on chagning the README, but we should add one for documentation.

@thanethomson
Copy link
Contributor Author

Just for clarification, when you say Tendermint-related references you're not just talking about renaming the word Tendermint but also any references to documentation for example ?

Yes, exactly.

This repo's docs are far more lightweight than CometBFT's, so I thought we could capture it all in a single issue/PR combo.

@thanethomson thanethomson self-assigned this Jan 16, 2023
@thanethomson thanethomson mentioned this issue Jan 16, 2023
Merged
@github-project-automation github-project-automation bot moved this from Todo to Done in CometBFT 2023 Jan 17, 2023
@thanethomson thanethomson added the rename Renaming our fork label Jan 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@thanethomson thanethomson

Labels
documentation Improvements or additions to documentation rename Renaming our fork
Projects
No open projects
CometBFT 2023
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Rename to CometBFT cometbft/cometbft-db
3 participants
@thanethomson @jmalicevic @andynog
0