Skip to content

Documentation Overhaul#2929

Merged
ehildenb merged 11 commits intodevelopfrom
doc-update
Sep 30, 2022
Merged

Documentation Overhaul#2929
ehildenb merged 11 commits intodevelopfrom
doc-update

Conversation

@ehildenb
Copy link
Copy Markdown
Member

@ehildenb ehildenb commented Sep 29, 2022 •
edited
Loading

Fixes: #2928
Fixes: #2764

This PR addresses the above issues, and overhauls the webpage a bit with these changes:

  • Moves the USER_MANUAL.md into docs/user_manual.md.
  • Splits it into two files, docs/user_manual.md and docs/ktools.md.
  • Adds a file docs/cheat_sheet.md.
  • Removes the links to a /downloads landing page in favor of direct link to GitHub release for Installation instructions.
  • Adds links to the new documents on the TOC and the front page.
  • Emphasizes the new K Tutorial over the PL Tutorial in the TOC and the front page.
  • Emphasizes resources for people looking to use K over the theoretical background links on the front page.
  • Calls out a separate Support section, with an updated link to our Discord channel, on the front page.

@rv-jenkins rv-jenkins changed the base branch from master to develop September 29, 2022 20:37
@ehildenb
Copy link
Copy Markdown
Member Author

ehildenb commented Sep 29, 2022

I've tested that this makes a working website locally.

@ehildenb ehildenb marked this pull request as ready for review September 29, 2022 21:02
@ehildenb ehildenb self-assigned this Sep 30, 2022
@ehildenb ehildenb requested a review from shd101wyy September 30, 2022 03:05
shd101wyy
shd101wyy approved these changes Sep 30, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@shd101wyy shd101wyy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@ehildenb ehildenb merged commit 7ad311f into develop Sep 30, 2022
@ehildenb ehildenb deleted the doc-update branch September 30, 2022 03:15
@radumereuta radumereuta mentioned this pull request Oct 19, 2022
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@radumereuta radumereuta Awaiting requested review from radumereuta

1 more reviewer

@shd101wyy shd101wyy shd101wyy approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@ehildenb ehildenb

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Split user manual into docs directory [doc] include a Cheat Sheet for useful commands - restructure documentation?

2 participants

@ehildenb @shd101wyy