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

Clean up README.md, made SETUP.md #1274

Closed
wants to merge 2 commits into from

Conversation

kirbyfern
Copy link
Contributor

@kirbyfern kirbyfern commented Jul 6, 2020

Summary

  • Clean up README
  • create separate SETUP.md
  • update CONTRIBUTING

PREVIEW: https://github.com/kirbygit/docsify/tree/update-readme

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

@vercel
Copy link

vercel bot commented Jul 6, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/8q5b9k4kd
✅ Preview: https://docsify-preview-git-fork-kirbygit-update-readme.docsify-core.vercel.app

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jul 6, 2020

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 0276fb7:

Sandbox Source
docsify-template Configuration

@kirbyfern
Copy link
Contributor Author

#1224

@trusktr trusktr changed the base branch from develop to update-readme July 7, 2020 18:05
@trusktr
Copy link
Member

trusktr commented Jul 7, 2020

Thanks @kirbygit For the ideas! As we chatted about,

  • Let's make separate PRs, one just for the tag line for example. (don't forget to set the base branch of those PRs to Docsify's update-readme branch)
  • Regarding SETUP.md I believe we should have content like that in the docs/ so we can show it on the site as well. People can still navigate the files here on GitHub too.

@trusktr
Copy link
Member

trusktr commented Jul 7, 2020

Another thing is (and note I made a separate PR for CONTRIBUTING.md, but maybe we should merge into one PR) maybe we can put the contributing guide in the docs, and link to it?

For example, this is how my one of my projects' CONTRIBUTING.md files looks like: https://github.com/lume/lume/blob/develop/CONTRIBUTING.md (WIP)

My thought is then we can have all things easily in one place. Having the root CONTRIBUTING.md file satisfies the GitHub community requirement (https://github.com/docsifyjs/docsify/community), so in my project's case I just link to the docs.

@kirbyfern
Copy link
Contributor Author

Thanks @kirbygit For the ideas! As we chatted about,

  • Let's make separate PRs, one just for the tag line for example. (don't forget to set the base branch of those PRs to Docsify's update-readme branch)
  • Regarding SETUP.md I believe we should have content like that in the docs/ so we can show it on the site as well. People can still navigate the files here on GitHub too.

Will make a small PR's for every change made. I agree that linking the SETUP.md inside /docs so we can show it on the site as well and people can also navigate the file from here. For that setup.md, do you think that content is perfectly fine?

Another thing is (and note I made a separate PR for CONTRIBUTING.md, but maybe we should merge into one PR) maybe we can put the contributing guide in the docs, and link to it?

For example, this is how my project's CONTRIBUTING.md file looks like: https://github.com/lume/lume/blob/develop/CONTRIBUTING.md

Whats the best way to merge that PR to here?

<p align="center">
<a href="https://docsify.js.org">
<img alt="docsify" src="https://github.com/docsifyjs/docsify/blob/develop/docs/_media/icon.svg">
</a>
</p>

<p align="center">
A magical documentation site generator.
<b>Docsify</b>, a magical documentation site generator that has no statically built html files. It is simple and lightweight with a smart full-text search plugin and multiple themes, useful plugin API, compatible with IE11. It also supports both <a href="https://github.com/docsifyjs/docsify-ssr-demo">SSR</a> and embedded files.
Copy link
Member

Choose a reason for hiding this comment

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

@sy-records this is good, honestly we need more details because "magical" on the cover doesn't say much. Although I think we might become incompatible with IE11 now, and we shouldn't mention experimental and incomplete/broken SSR support.

Copy link
Member

Choose a reason for hiding this comment

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

Isn't there a description of some Features below? https://docsify.js.org/#/?id=features

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