Skip to content

Commit

Permalink
chore(core): code documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Jun 17, 2024
1 parent 212ec76 commit 352ce41
Show file tree
Hide file tree
Showing 212 changed files with 4,018 additions and 6,985 deletions.
22 changes: 17 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

Thank you for showing interest in contributing to this project. This guide provides some basic guidelines for doing so.

## Contents

- [Contributing Guide](#contributing-guide)
- [Contents](#contents)
- [Introduction](#introduction)
- [Contributions to the public docs](#contributions-to-the-public-docs)
- [Contributing to the codebase](#contributing-to-the-codebase)
- [Submitting a Pull Request](#submitting-a-pull-request)
- [Contributors](#contributors)

## Introduction

Before you start, you might find it helpful to read the [TypeDoc development guide](https://typedoc.org/guides/development/) to understand the architecture of TypeDoc itself.

## Contributions to the public docs
Expand All @@ -16,18 +28,18 @@ When submitting a PR please use commit message in the format `chore(docs): impro

## Contributing to the codebase

For contributing to the plugin codebase, please see the [Developer Documentation](./developer-docs/README.md) for detailed information about the codebase and development practices.
For contributing to the plugin codebase, please see the [Developer Documentation](./packages/typedoc-plugin-markdown/developer-docs/README.md) for detailed information about the codebase and development practices.

All contributions are welcome and appreciated. If something does not make sense please do not hesitate to [ask for help](/discussions/categories/help).

## Submitting a Pull Request

Once you're ready to submit your changes:

* **Push your branch**: Push your branch to your forked repository on GitHub.
* **Create a PR**: Navigate to the original repository and create a PR from your branch to the main branch.
* **Provide a clear description**: Include a detailed description of your changes, why they're necessary, and any issues they resolve.
* **Link to relevant issues**: If your PR addresses any open issues, mention them in the description.
- **Push your branch**: Push your branch to your forked repository on GitHub.
- **Create a PR**: Navigate to the original repository and create a PR from your branch to the main branch.
- **Provide a clear description**: Include a detailed description of your changes, why they're necessary, and any issues they resolve.
- **Link to relevant issues**: If your PR addresses any open issues, mention them in the description.

Please note we follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.

Expand Down
8 changes: 0 additions & 8 deletions developer-docs/README.md

This file was deleted.

17 changes: 0 additions & 17 deletions developer-docs/typedoc-plugin-frontmatter/README.md

This file was deleted.

12 changes: 0 additions & 12 deletions developer-docs/typedoc-plugin-frontmatter/app/README.md

This file was deleted.

This file was deleted.

This file was deleted.

15 changes: 0 additions & 15 deletions developer-docs/typedoc-plugin-frontmatter/options/README.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 352ce41

Please sign in to comment.