bridge-in-tech-web
bridge-in-tech-web copied to clipboard
anitab-org
Docs: Add badges to docusauras Home.md
Is your feature request related to a problem? Please describe.
Add badges to the docusauras home.md
Describe the solution you'd like
Additional context
None
Hello there!👋 Welcome to the project!💖
Thank you and congrats🎉for opening your very first issue in this project. AnitaB.org is an inclusive community, committed to creating a safe and positive environment.🌸 Please adhere to our Code of Conduct.🙌 You may submit a PR if you like! If you want to report a bug🐞 please follow our Issue Template. Also make sure you include steps to reproduce it and be patient while we get back to you.😄
Feel free to join us on AnitaB.org Open Source Zulip Community.💖 We have different streams for each active repository for discussions.✨ Hope you have a great time there!😄
![welcome[bot] avatar](https://avatars.githubusercontent.com/in/4141?v=4 "Published by a pub.dev verified publisher"){kind=small}
@Amulya-coder Please remove the fork and star label from the screenshot as there is no need for them. Also, there is a zulip label already. Please remove that as well.
I don't think we need "Maintained" and "PRs" tags either, @Amulya-coder. Plus, the License already shown on Github UI, so please remove that as it is redundant.
Saying that, I don't mind seeing all the GitHub UI tags + README tags being included in the docusaurus Home.md since we won't be able to see the GitHub UI tags there. PS: @Rahulm2310 , while we're on the docusaurus topic, is it possible to use .md parser from the wiki .md files, that way we'll avoid the risk of having 2 different contents (wiki vs docusaurus). If we can use the .md parser in Home.md on docusaurus under the tags, that'll be best.
What do you all think?
If we can use the .md parser in Home.md on docusaurus under the tags, that'll be best.
@mtreacy002 Unable to get your point. Can you be more clear
@Rahulm2310, at the moment we have a copy of Home.md in the docusaurus docs folder (along with other .md files as well).
The issue with this, if the content in wiki page is modified, the changes will not be automatically detected in the docusaurus .md version which means we'll have conflicting information. If we can use the .md parser on our docusaurus, then the changes made to wiki will automatically applied to docusaurus. So, that's the first point I have in mind.
The second point is on the redundant tags that we don't want to have on README.md files since they are visible on Github UI. IMO, these tags are redundant on the README.md file for the repo, but they are important information that currently missing on the docusaurus Home.md. So, my suggestion is to add the tags in the docusaurus Home.md.
I hope this helps explain my intention better 😉
Hi @mtreacy002 @Rahulm2310 @Amulya-coder I'd like to work on it , can you assign it to me .?
@naveen8801 thanks for showing interest in this issue, firstly I give you the idea about this issue -> you have to add the badges on the docusauras Home.md so that it's visible on the docusauras documentation not on readme as explained by the mtreachy above ☝ would you know how to do that? if yes I will assign it to you.
@Amulya-coder , i think you are talking about this https://github.com/anitab-org/bridge-in-tech-backend/tree/develop/docs/docs , and here Home.md should contain these badges or something else ?
Ya i'd like to work on it , but this means that i have to submit PR for ' bridge-in-tech-backend ' repo , right ?
@Amulya-coder I think this should be put on hold as we don't have the docusaurus website for frontend yet. Also, please update the issue description with what needs to be done.
I have a doubt regarding the task what needs to be done? I can see the badges here https://github.com/anitab-org/bridge-in-tech-backend/blob/develop/docs/docs/Home.md Do I need to add any more? Or need to add them somewhere else?
Thank you in advance
@IC1101Virgo you need to add the badges here on this repo i.e. bridge-in-tech-web. The link you are using is for the backend repo.
@Rahulm2310, I want to contribute to the project, can i work on this issue?
@harsh-9in will assign to you since there are no updates for a while from @IC1101Virgo
@IC1101Virgo if I got this wrong and you are still interested in contributing, let us know :)
Hello. Is this issue still open? @isabelcosta @Amulya-coder . If yes. Can I work on it?
