Skip to content

Add improved docs#33

Merged
wooorm merged 6 commits intomainfrom
docs
Oct 28, 2021
Merged

Add improved docs#33
wooorm merged 6 commits intomainfrom
docs

Conversation

@wooorm
Copy link
Copy Markdown
Member

@wooorm wooorm commented Oct 26, 2021

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

View rendered

Related-to: unifiedjs/unified#168.

/cc @nemo-omen @remcohaszing @ChristianMurphy @Murderlon

@wooorm wooorm added the 📚 area/docs This affects documentation label Oct 26, 2021
@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Oct 26, 2021
@codecov-commenter

This comment has been minimized.

wooorm and others added 3 commits October 26, 2021 21:34
Co-authored-by: Christian Murphy <christian.murphy.42@gmail.com>
@wooorm wooorm added the 💪 phase/solved Post is done label Oct 28, 2021
@wooorm wooorm merged commit c542bde into main Oct 28, 2021
@wooorm wooorm deleted the docs branch October 28, 2021 09:43
@github-actions github-actions bot removed the 🤞 phase/open Post is being triaged manually label Oct 28, 2021
@github-actions

This comment has been minimized.

This package is a [unified][] ([remark][]) plugin to link references to commits,
issues, and users: `@wooorm` -> `[**@wooorm**](https://github.com/wooorm)`.

**unified** is a project that transforms content with abstract syntax trees
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

For my internal docs, talking about Remark I usually link AST to a wiki article 😁 not sure if you want to include such a link in these docs.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It’s a good point.

I want to refrain from linking (and emphasing) too much. While sometimes useful, a bunch of links can also distract from reading through a readme like this.

It’s really subjective what enough is, and what should be linked. In this case, I’m hoping that people wondering about the term can Google/Wiki it themselves.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📚 area/docs This affects documentation 💪 phase/solved Post is done

Development

Successfully merging this pull request may close these issues.

4 participants