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

refactor: shorter titles #6

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Conversation

Duologic
Copy link
Member

I think it might be less confusing to have shorter titles, this makes the list on the index page easier to scan for a certain topic.

wdyt?

1. [Package management](lesson2.md)
1. [Refactoring exercise](lesson3.md)
1. [Wrapping libraries](lesson4.md)
1. [Documentation](lesson5.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

make this Documenting instead of `Documentation. That will tell me it is about how I do something.

Copy link
Collaborator

Choose a reason for hiding this comment

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

or better: Documenting Code.

1. [Exercise: rewrite a library with `k8s-libsonnet`](lesson3.md)
1. [Further developing libraries](lesson4.md)
1. [Providing documentation with Docsonnet](lesson5.md)
1. [Introduction exercise](lesson1.md)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
1. [Introduction exercise](lesson1.md)
1. [Introductory exercise](lesson1.md)

@@ -1,8 +1,8 @@
# Write an extensible library
# Introduction exercise
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# Introduction exercise
# Introductory exercise

@@ -1,4 +1,4 @@
# Providing documentation with Docsonnet
# Documentation
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# Documentation
# Documenting Code

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.

2 participants