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

Copy readme contents to documentation project #164

Conversation

Raithlin
Copy link
Contributor

@Raithlin Raithlin commented Dec 26, 2023

The creation of the Package Reference pages that replace the readme.md details.

Copy link
Owner

@warriordog warriordog left a comment

Choose a reason for hiding this comment

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

@Raithlin Great work, thank you! I do have a couple of requests:

  1. Could we move these to the "User Guide" section instead of "Dev Resources"? And maybe even add a sub-section to group them, like "Package Reference" or something.
  2. Would you additionally replace the original files (in the code area) with just a header and a link to these new documentation files?

@warriordog warriordog self-assigned this Dec 29, 2023
@warriordog warriordog added area:docs Affects or applies to the documentation type:improvement Non-feature improvements to the library labels Dec 29, 2023
@Raithlin
Copy link
Contributor Author

Raithlin commented Dec 29, 2023

@warriordog I think I got this right, but without a local setup to mirror the github.io docs I can't be sure. I may need to rename the Package Reference folder to Package_Reference or similar.

@Raithlin Raithlin changed the title Copy readme contents to Dev Resources Copy readme contents to Github.io documentation Dec 29, 2023
@Raithlin Raithlin changed the title Copy readme contents to Github.io documentation Copy readme contents to documentation project Dec 29, 2023
@Raithlin Raithlin requested a review from warriordog December 29, 2023 19:09
@warriordog
Copy link
Owner

@Raithlin sorry for not responding - I've been very busy recently. You can test locally by running docfx docfx.json --serve from the documentation folder. (side note - I should add that in the documentation somewhere.)

Copy link
Owner

@warriordog warriordog left a comment

Choose a reason for hiding this comment

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

Looks great, thank you!

@warriordog warriordog merged commit 168b85e into warriordog:main Jan 4, 2024
3 checks passed
@Raithlin Raithlin deleted the 138-move-readme-docs-into-documentation-project branch January 4, 2024 20:19
@Raithlin Raithlin restored the 138-move-readme-docs-into-documentation-project branch January 4, 2024 20:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs Affects or applies to the documentation type:improvement Non-feature improvements to the library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants