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

feat : added the bitcoin-connect docs onto a new branch deploy-folder #209

Closed
wants to merge 1 commit into from

Conversation

vr-varad
Copy link

@vr-varad vr-varad commented Mar 8, 2024

Description

This pull requests all the docusaurus docs website to the deploy-folder branch.

Resolves

#159

@vr-varad
Copy link
Author

vr-varad commented Mar 8, 2024

I apologize for my negligence last time ;)

@rolznz
Copy link
Collaborator

rolznz commented Mar 8, 2024

Hi @vr-varad

You should not commit build outputs to the repository, it unnecessary bloats it and creates giant change requests.

Also, I asked if you could make a github pages site on a fork so we could try it and see what files need to be committed - you didn't do that.

I appreciate your effort but I unfortunately do not have a lot of time to re-review and re-ask for the same thing multiple times.

@vr-varad
Copy link
Author

vr-varad commented Mar 8, 2024

With Docusaurus I need a repo with the docusaurus website like I did inside https://github.com/vr-varad/bitcoin-connect-docs
and I deployed on GitHub pages https://vr-varad.github.io/bitcoin-connect-docs/
Certainly! If you could please provide more details or clarify your question, I would be happy to help.

@vr-varad
Copy link
Author

vr-varad commented Mar 8, 2024

Hey @rolznz can u guide me a little bit? more so that I can work on it without any issues and problems.

Copy link

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/[email protected] environment, filesystem Transitive: network, shell, unsafe +82 11.9 MB adamwathan

View full report↗︎

@rolznz
Copy link
Collaborator

rolznz commented Mar 10, 2024

Hi, the newly-deployed site looks better now - the left sidebar items are mostly good now.

https://vr-varad.github.io/bitcoin-connect-docs/usage/other_frameworks however contains Pure HTML - can you move that out into its own section?

And https://vr-varad.github.io/bitcoin-connect-docs/faq is broken - "Need help?" and FAQ should be split and each FAQ item should be a separate subpage.

Could you look at https://medium.com/@nathvichea/github-action-to-deploy-docusaurus-8c297eaf1514 ? Ideally we can use a github action to build the site so it'll be updated on every commit.

I was originally hoping to also see these additions in a fork of Bitcoin Connect, not a completely separate documentation repository.

@vr-varad
Copy link
Author

Sure I am working on it;)

@vr-varad
Copy link
Author

I applied the GitHub Actions. Should I update the PR??? @rolznz

@vr-varad
Copy link
Author

I am trying to put a custom domain to it as bitcoin-connect-docs.com but it shows me
Both bitcoin-connect-docs.com and its alternate name are improperly configured
What could I do any ideas? @rolznz

@rolznz
Copy link
Collaborator

rolznz commented Mar 12, 2024

@vr-varad did you buy that domain? I wouldn't expect you to do that. For example, we could use a subdomain on our existing domain like docs.bitcoinconnect.com (but I think a github pages URL is perfectly fine for now)

@vr-varad
Copy link
Author

vr-varad commented Mar 12, 2024

so should I commit the changes I made into this PR @rolznz and also change the docs link in the main website?

@vr-varad
Copy link
Author

@rolznz any further updates?

@rolznz
Copy link
Collaborator

rolznz commented Mar 14, 2024

@vr-varad I think I have given you enough information to work on the issue.

@vr-varad
Copy link
Author

Hey @rolznz, I sincerely apologize for bombarding you with so many questions. I hope you can forgive my eagerness. I just wanted to kindly inquire about the progress regarding the changes I made to the documentation website. If it's convenient for you, could you please inform me if I should proceed with implementing these changes on the main website? If so, could you please guide me on where to find the codebase for the main website? If not, I completely understand, and I would appreciate your guidance on what steps should be taken next. Once again, I apologize for any inconvenience caused by my inquiries. Your assistance is greatly appreciated. Thank you for your understanding.

@rolznz
Copy link
Collaborator

rolznz commented Mar 15, 2024

Hi @vr-varad we do not want any changes on the main website. This should be an isolated documentation site hosted on github pages.

@vr-varad
Copy link
Author

vr-varad commented Mar 15, 2024

Hey @rolznz, I just wanted to extend my gratitude for your assistance. Looking forward to collaborating more in the future. By the way, Appreciate any advice or support you can offer on this. Thanks again!

@vr-varad
Copy link
Author

Any particular issue I could work on?

@rolznz
Copy link
Collaborator

rolznz commented Mar 21, 2024

@vr-varad do you not want to finish this one? you should be able to re-read the requirements I gave in previous replies in this pull request

@rolznz
Copy link
Collaborator

rolznz commented Apr 29, 2024

closing due to inactivity

@rolznz rolznz closed this Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants