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

Index for documentation and tables of content #1779

Merged
merged 24 commits into from Sep 28, 2022
Merged

Conversation

muddv
Copy link
Contributor

@muddv muddv commented Sep 28, 2022

Added index.md which lists every file in docs/ folder with links to every chapter
Also added table of contents for each individual doc

docs/writing-a-plugin.md Outdated Show resolved Hide resolved
@@ -14,6 +14,25 @@ See also [ClojureWerkz’s recommendations] for open source projects.
[`gulp‑postcss`]: https://github.com/w0rm/gulp-postcss
[`postcss-cli`]: https://github.com/postcss/postcss-cli

**Table of Contents**

* [PostCSS Runner Guidelines](#postcss-runner-guidelines)
Copy link
Member

Choose a reason for hiding this comment

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

We need to remove all other roots too

docs/index.md Outdated Show resolved Hide resolved
@@ -1,5 +1,14 @@
# Writing a PostCSS Plugin

* [Writing a PostCSS Plugin](#writing-a-postcss-plugin)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* [Writing a PostCSS Plugin](#writing-a-postcss-plugin)
**Table of Contents**
* [Writing a PostCSS Plugin](#writing-a-postcss-plugin)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changed this

@@ -4,8 +4,6 @@ General overview of the PostCSS architecture.
It can be useful for everyone who wishes to contribute to the core or develop a better understanding of the tool.

**Table of Contents**

* [PostCSS Architecture](#postcss-architecture)
* [Overview](#overview)
Copy link
Member

Choose a reason for hiding this comment

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

Can I also ask you to remove the indent of the block (for consistency) and we are ready to merge

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is also a root link, but I did not add it, should I remove it too?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, for consistancy

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done!

Co-authored-by: Andrey Sitnik <andrey@sitnik.ru>
@ai ai merged commit cedc6a5 into postcss:main Sep 28, 2022
@ai
Copy link
Member

ai commented Sep 28, 2022

Great. Now our docs looks better. Thanks.

@muddv
Copy link
Contributor Author

muddv commented Sep 28, 2022

Glad to help! Thanks for guidance in ironing out the wrinkles

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.

None yet

2 participants