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.

Sign up for GitHub

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

Jump to bottom

Fix Typo and Improve Documentation Consistency in README.md #249

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −13
Open

Fix Typo and Improve Documentation Consistency in README.md #249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,35 +7,32 @@ written in [Starlark](https://bazel.build/docs/skylark/index.html).

Stardoc provides a Starlark rule (`stardoc`, see [documentation](docs/stardoc_rule.md)) that can
be used to build documentation for Starlark rules in Markdown. Stardoc generates one documentation
page per `.bzl`file.
page per `.bzl` file.

## Get Started

* How to [set up Stardoc for your project](docs/getting_started_stardoc.md)
* Writing [docstrings](docs/writing_stardoc.md)
* How to [integrate Stardoc with your build](docs/generating_stardoc.md).
* See also [Advanced Topics](docs/advanced_stardoc_usage.md).
* How to [integrate Stardoc with your build](docs/generating_stardoc.md)
* See also [Advanced Topics](docs/advanced_stardoc_usage.md)

## About Stardoc

* Stardoc [rule reference](docs/stardoc_rule.md).
* Stardoc [rule reference](docs/stardoc_rule.md)
* How to [contribute to Stardoc](docs/contributing.md)

## Project Status

### Skydoc deprecation
### Skydoc Deprecation

Stardoc is a replacement for the **deprecated** "Skydoc" documentation generator.

See [Skydoc Deprecation](docs/skydoc_deprecation.md) for
details on the deprecation and migration details.
See [Skydoc Deprecation](docs/skydoc_deprecation.md) for details on the deprecation and migration details.

### Future plans
### Future Plans

See our [future plans](docs/future_plans.md) for refactoring Stardoc to be more consistent with how Bazel evaluates .bzl files, and what it means for maintenance of this project.
See our [future plans](docs/future_plans.md) for refactoring Stardoc to be more consistent with how Bazel evaluates `.bzl` files, and what it means for maintenance of this project.

### Maintainer's guide

See the [maintaner's guide](docs/maintainers_guide.md) for instructions for
cutting a new release.
### Maintainer's Guide

See the [Maintainer's guide](docs/maintainers_guide.md) for instructions on cutting a new release.