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

docs: modified the structure of readme and added some content #1796

Merged
merged 10 commits into from
Dec 5, 2022

Conversation

qqqzhch
Copy link
Contributor

@qqqzhch qqqzhch commented Nov 29, 2022

Reorganized the structure of readme content

add setup.md abount How to run Alby in the local development environment
add alby-logo to docs folder
add alby horizontal banner at the start of the readme
add about alby to readme
edit a link in readme from RTL to Thunderhub

Fixes #651

Type of change

(Remove other not matching type)

  • docs: Documentation update

Screenshots of the changes [optional]

  • Screenshot of the readme section 1
    a
  • Screenshot of the readme section 2
    a
  • Screenshot of the readme section 3
    a
  • Screenshot of the readme section 4
    a

How has this been tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Checklist

  • My code follows the style guidelines of this project and performed a self-review of my own code
  • New and existing tests pass locally with my changes
  • I checked if I need to make corresponding changes to the documentation (and made those changes if needed)

@escapedcat
Copy link
Contributor

Nice!

Please run this in your repo to solve the failing linting check:
yarn && yarn lint

README.md Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Nov 29, 2022

🚀 Thanks for the pull request!

Here are the current build files for testing:

Download and unzip the file for your browser. Refer to the readme for detailed install instructions.

Don't forget: keep earning sats!

@qqqzhch
Copy link
Contributor Author

qqqzhch commented Nov 30, 2022

I have another question
After executing yarn&&yarn lint

=============

WARNING: You are currently running a version of TypeScript which is not officially supported by @typescript-eslint/typescript-estree.

You may find that it works just fine, or you may not.

SUPPORTED TYPESCRIPT VERSIONS: >=3.3.1 <4.9.0

YOUR TYPESCRIPT VERSION: 4.9.3

Please only submit bug reports when using the officially supported version.

=============
{
"@typescript-eslint/eslint-plugin": "^5.42.0",
"@typescript-eslint/parser": "^5.42.0",
}
I checked https://github.com/typescript-eslint/typescript-eslint/tree/v5.42.0
The version range of TypeScript currently supported by this parser is >=3.3.1 <4.9.0

typescript in package

{ "typescript": "^4.9.3", }
Do i need to upgrade the typescript eslnt version number to a matching typescript version in another pr

@escapedcat
Copy link
Contributor

I have another question After executing yarn&&yarn lint
...
{ "typescript": "^4.9.3", } Do i need to upgrade the typescript eslnt version number to a matching typescript version in another pr

No, all good. That's just a warning because our TS version is a bit too new.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
doc/Setup.md Outdated Show resolved Hide resolved
@escapedcat
Copy link
Contributor

I think it's common to keep md-files uppercase:
https://github.com/LN-Zap/zap-desktop/tree/master/docs

README.md Show resolved Hide resolved
doc/SETUP.md Outdated Show resolved Hide resolved
@escapedcat
Copy link
Contributor

Last changes, thanks @qqqzhch !

README.md Outdated Show resolved Hide resolved
@escapedcat
Copy link
Contributor

Thanks @qqqzhch , let's merge this and see how it feels

@escapedcat escapedcat merged commit b985020 into getAlby:master Dec 5, 2022
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.

docs refactor existing readme and add new documentation
3 participants