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

Improvements to Reference docs #13

Closed
1 of 14 tasks
eladb opened this issue Dec 8, 2019 · 1 comment
Closed
1 of 14 tasks

Improvements to Reference docs #13

eladb opened this issue Dec 8, 2019 · 1 comment
Labels
documentation This is a problem with documentation. status/stale The RFC did not get any significant enough progress or tracking and has become stale.

Comments

@eladb
Copy link
Contributor

eladb commented Dec 8, 2019

PR Champion
#

Description

  • Open source multi-language doc renderer (jsii?)
  • Add the single universal experience support all languages
  • Consider whether we still want the idiomatic references
  • SEO
  • Overall stability matrix
  • Remove per-module stability and only show per-construct stability (suggested by @rhboyd)
  • Google juice is pretty bad right now. All languages in one AWSDocs-like template, better crosslinking, better search (@rix0rrr)

Progress

  • Tracking Issue Created
  • RFC PR Created
  • Core Team Member Assigned
  • Initial Approval / Final Comment Period
  • Ready For Implementation
    • implementation issue 1
  • Resolved
@eladb eladb added the documentation This is a problem with documentation. label Dec 8, 2019
@eladb eladb changed the title API reference website improvements Reference documentation improvements Dec 10, 2019
@MrArnoldPalmer MrArnoldPalmer added the status/proposed Newly proposed RFC label Jan 4, 2020
@eladb eladb changed the title Reference documentation improvements Improvements to Reference docs Apr 7, 2020
@mrgrain mrgrain added status/stale The RFC did not get any significant enough progress or tracking and has become stale. and removed status/proposed Newly proposed RFC labels Oct 27, 2023
@mrgrain
Copy link
Contributor

mrgrain commented Oct 27, 2023

While docs still need improvements, this issue predates the current docs.

Marking this RFCs as stale since there has been little recent activity and it is not currently close to getting accepted as-is. We appreciate the effort that has gone into this proposal. Marking an RFCs as stale is not a one-way door. If you have made substantial changes to the proposal, please open a new issue/RFC. You might also consider raising a PR to aws/aws-cdk directly or self-publishing to Construct Hub.

@mrgrain mrgrain closed this as completed Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. status/stale The RFC did not get any significant enough progress or tracking and has become stale.
Projects
None yet
Development

No branches or pull requests

3 participants