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.

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

Improve "Getting Started" instructions #44

Open
3 of 6 tasks
audreyfeldroy opened this issue Oct 4, 2023 · 4 comments
Open
3 of 6 tasks

Improve "Getting Started" instructions #44

audreyfeldroy opened this issue Oct 4, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation hacktoberfest-accepted Issue or PR is approved for anyone who wants it to count toward Hacktoberfest help wanted Extra attention is needed

Comments

@audreyfeldroy
Copy link
Member

audreyfeldroy commented Oct 4, 2023 •
edited
Loading

  • Move the getting started section from the readme into its own file in the docs folder
  • Link to the new getting started file in the docs folder once created, from other places that reference it:
  • Try them out and make corrections as needed
@audreyfeldroy audreyfeldroy changed the title Improve "Getting Started" instructions Note: I'm outside using voice typing on my phone, and my hands are too cold to make corrections, so pardon typos! Typos! I'll fix them as soon as I get into the British library and sit down in a warm spot to type. Improve "Getting Started" instructions Oct 4, 2023
audreyfeldroy added a commit that referenced this issue Oct 4, 2023
@audreyfeldroy
Move "Getting Started" to its own page in docs/
72ca377 
Part of Improve "Getting Started" instructions #44

I like to follow this pattern to allow for future expansion.
@audreyfeldroy audreyfeldroy added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Oct 4, 2023
@audreyfeldroy
Copy link
Member Author

Having some trouble getting getting_started.rst to appear on the index page of the docs, anyone want to try?

@EggHeadTimothy
Copy link

I could take a look at moving getting_started.rst to docs, can you assign this to me?

@audreyfeldroy audreyfeldroy added the hacktoberfest-accepted Issue or PR is approved for anyone who wants it to count toward Hacktoberfest label Oct 5, 2023
@audreyfeldroy
Copy link
Member Author

Sure, it's yours @EggHeadTimothy, thanks!

@audreyfeldroy audreyfeldroy mentioned this issue Oct 6, 2023
Closed
5 tasks
@EggHeadTimothy
Copy link

I forked the repository and took a closer look and this is beyond what I know how to work with. My apologies

@EggHeadTimothy EggHeadTimothy removed their assignment Oct 6, 2023
pydanny added a commit that referenced this issue Oct 6, 2023
@pydanny @audreyfeldroy
Fix documentation issues
6e392cb 
- Flattened Sphinx setup per Zen of Python
- Corrected format of getting_started. Addresses #57
- Touches on #44 but does not close it

Co-Authored-By: Audrey Roy Greenfeld <[email protected]>
@pydanny pydanny mentioned this issue Oct 6, 2023
Merged
pydanny added a commit that referenced this issue Oct 6, 2023
@pydanny @audreyfeldroy
Fix documentation issues
424db96 
- Flattened Sphinx setup per Zen of Python
- Corrected format of getting_started. Addresses #57
- Touches on #44 but does not close it

Co-Authored-By: Audrey Roy Greenfeld <[email protected]>
RalphHuber pushed a commit to RalphHuber/HistoryAIToolkit that referenced this issue Oct 7, 2023
@audreyfeldroy @RalphHuber
Move "Getting Started" to its own page in docs/
bf4c338 
Part of Improve "Getting Started" instructions crisishistory#44

I like to follow this pattern to allow for future expansion.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation hacktoberfest-accepted Issue or PR is approved for anyone who wants it to count toward Hacktoberfest help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@audreyfeldroy @EggHeadTimothy