Skip to content

User setup documentation - #121

Open
noahpop77 wants to merge 14 commits into
RiotGames:mainfrom
noahpop77:user-setup-documentation
Open

User setup documentation#121
noahpop77 wants to merge 14 commits into
RiotGames:mainfrom
noahpop77:user-setup-documentation

Conversation

@noahpop77

Copy link
Copy Markdown

I wrote some documentation that could help others get up and running with KeyConjurer easier. The main README.md file has some context and information on the project but does not have any reproducible steps laid out. The user documentation would help to get people up and running with the project. There is still more to detail but this could help to make KeyConjurer a more user contributor friendly open-source project!

If you have any advice or feedback I would love to hear it!

@punmechanic

Copy link
Copy Markdown
Member

Hi Noah, thanks for your contribution. I'm off work until Jan 6th 2025 and will respond to this when I am back :)

@noahpop77

Copy link
Copy Markdown
Author

No worries! Hope to be able to help out where I can with KeyConjurer, It seems like a really interesting tool.

@punmechanic

Copy link
Copy Markdown
Member

Hello,

So, documentation from an end-user pov (not a maintainer of the app, but someone using KeyConjurer) is located inside [the frontend folder][./frontend], however I'd be willing to accept a pull request that just has the build instructions you've provided added to README.md

@noahpop77

Copy link
Copy Markdown
Author

OK I will make the changes to the README.md rather than the setup.md file and resubmit the PR.

@noahpop77

Copy link
Copy Markdown
Author

OK @punmechanic I cleaned up the documentation a bit and added it to the current README. Also thanks for letting me know that the documentation for an end user is in the frontend folder. If theres any changes you think would be helpful let me know 😁

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