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

chore: update docs #330

Merged
merged 9 commits into from
Dec 31, 2023
Merged

chore: update docs #330

merged 9 commits into from
Dec 31, 2023

Conversation

DaveSkender
Copy link
Member

@DaveSkender DaveSkender commented Dec 31, 2023

General documentation updates. No code changes.

To do:

  • add more instructions for developers in contributing.md
  • remove remote_theme: pages-themes/[email protected] templates, similar to .NET project
  • update general stylesheets similarly as well
  • replace use of jemoji gem and GitHub emoji syntax, in favor of plain ASCII emoji (see .NET project)
  • fix fonts on indicator pages

Checklist

  • My code follows the existing style, code structure, and naming taxonomy
  • I have commented my code, particularly in hard-to-understand areas
  • I have performed a self-review of my own code and included any verifying manual calculations
  • I have added or updated unit tests that prove my fix is effective or that my feature works, and achieves sufficient code coverage. New and existing unit tests pass locally and in the build (below) with my changes
  • My changes generate no new warnings and running code analysis does not produce any issues
  • I have added or run the performance tests that depict optimal execution times
  • I have made corresponding changes to the documentation

@DaveSkender DaveSkender linked an issue Dec 31, 2023 that may be closed by this pull request
4 tasks
@DaveSkender
Copy link
Member Author

@LeeDongGeon1996 my 2nd commit (826f0ee) is an update to installation and setup guidance. I found that I needed to install openpyxl separately to get it to work. Is that something that should go into the requirements-test.txt file?

@DaveSkender DaveSkender self-assigned this Dec 31, 2023
@DaveSkender DaveSkender marked this pull request as ready for review December 31, 2023 06:38
@DaveSkender DaveSkender marked this pull request as draft December 31, 2023 06:42
@DaveSkender DaveSkender marked this pull request as ready for review December 31, 2023 07:05
@DaveSkender DaveSkender enabled auto-merge (squash) December 31, 2023 07:13
Signed-off-by: Dave Skender <[email protected]>
@LeeDongGeon1996
Copy link
Member

LeeDongGeon1996 commented Dec 31, 2023

@DaveSkender There are some Nuget page links on Code of Conduct.md and Security.md. If these are not intended, please fix them.

@DaveSkender
Copy link
Member Author

@DaveSkender There are some Nuget page links on Code of Conduct.md and Security.md. If these are not intended, please fix them.

Those are intentional. It’s the only way I have right now to allow someone to privately communicate an issue without forcing them to connect through social media accounts, and without forcing me to publicly publish and email address for robots to pickup and spam.

Copy link
Member

@LeeDongGeon1996 LeeDongGeon1996 left a comment

Choose a reason for hiding this comment

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

LGTM

@DaveSkender DaveSkender merged commit cbe4ef3 into main Dec 31, 2023
18 checks passed
@DaveSkender DaveSkender deleted the 324-refactor-pages branch December 31, 2023 10:31
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

refactor: Pages use of GH template, jemoji gem
2 participants