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

update README #525

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mduffin95
Copy link

Pull Request

Description

I thought it would be clearer if there were some links to the individual README files on the landing page. This could probably do with editing from someone who has better knowledge of what these apps do.

Fixes #

How Has This Been Tested?

N/A - documentation

  • Yes

Checklist:

  • My code follows OCF's coding style guidelines
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked my code and corrected any misspellings

Copy link

vercel bot commented Jul 3, 2024

@mduffin95 is attempting to deploy a commit to the Open Climate Fix Team on Vercel.

A member of the Team first needs to authorize it.

@mduffin95 mduffin95 marked this pull request as ready for review July 3, 2024 22:21
@mduffin95
Copy link
Author

#524 see discussion for more context.

The following documentation explains how to get started with running each application:

- [nowcasting-app](apps/nowcasting-app/README.md) - The main Quartz Solar UI, hosted at [app.quartz.solar](app.quartz.solar).
- [nowcasting-website](apps/nowcasting-website/README.md) - The marketing website
Copy link
Contributor

Choose a reason for hiding this comment

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

I would remove this, as its odd. Also the ux-demo as they are old. Sorry we should remove these folder out the github repo too.

Copy link
Contributor

Choose a reason for hiding this comment

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

see #514

Copy link
Contributor

Choose a reason for hiding this comment

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

Yep, thanks for this @mduffin95 – if you remove nowcasting-website and ux-demos now they've been removed from the repo, we can get this merged 👍

@peterdudfield
Copy link
Contributor

@braddf you ok to review this? I think its a small change in the readme that helps point people in the right direction

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

Successfully merging this pull request may close these issues.

3 participants