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

Create Project GitHub Page #96

Closed
seanbsu opened this issue Apr 10, 2024 · 3 comments
Closed

Create Project GitHub Page #96

seanbsu opened this issue Apr 10, 2024 · 3 comments
Assignees
Labels

Comments

@seanbsu
Copy link
Collaborator

seanbsu commented Apr 10, 2024

create the project GitHub page as outlined in the github page assignment:
requirements

  • Project title
  • Team Members
  • Project abstract
    • Start with your project statement
    • Should be concise (~200 words)
    • Descriptive enough for someone outside to understand
  • Project Description
    • Describe what you actually built
    • How it works
    • Screenshots
@seanbsu seanbsu added the task label Apr 10, 2024
@seanbsu seanbsu self-assigned this Apr 10, 2024
@seanbsu
Copy link
Collaborator Author

seanbsu commented Apr 15, 2024

  • began work on the page by taking the github tutorial for creating a github page and adding a theme
  • followed a similar workflow from the tutorial to add a github page to our repo
  • created the config file and then created the skeleton for the page in index.md
  • pointed the build for the repo to this tasks branch and the doc folder will need to change when this branch gets merged into main
  • remember that it takes a while for changes to show up on the page's site even after the build checks have passed. guessing there's something in the deployment that takes a while to happen
    [t:90]

@seanbsu
Copy link
Collaborator Author

seanbsu commented Apr 17, 2024

  • Started work on the Abstract for the page taking from the edited showcase program abstract and adding to it to more fully encompass what our package does
  • began the project description section of the page mentioning design for pip install and how Dr Wright will be the one publishing the package. metioning how the algorithm works, preprocessing phase, the solve and multilevel etc,
    [t:75]

@seanbsu
Copy link
Collaborator Author

seanbsu commented Apr 18, 2024

  • added more to the description section
  • added plots for the levels data and the scatter plot of the solution to give some visuals to the page
    [t:45]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant