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

Improve site formatting #2183

Merged
merged 3 commits into from
Oct 12, 2024
Merged

Improve site formatting #2183

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4220a0b
Improve site formatting
nirs Aug 24, 2024
08fa116
Unify indentation in example project structure
nirs Aug 24, 2024
612f06f
Use single import line in the trivial examples
nirs Aug 24, 2024
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
14 changes: 7 additions & 7 deletions site/content/user_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ While you are welcome to provide your own organization, typically a Cobra-based
application will follow the following organizational structure:

```console
▾ appName/
▾ cmd/
add.go
your.go
commands.go
here.go
main.go
▾ appName/
▾ cmd/
add.go
your.go
commands.go
here.go
main.go
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if main.go is indented correctly. We can replace it with tree output which is much more clear to users and also used later below.

appName
├── cmd
│   ├── add.go
│   ├── your.go
│   ├── commands.go
│   └── here.go
└── main.go

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yeah, feel free to change this if you prefer.

Copy link
Collaborator

Choose a reason for hiding this comment

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

In a follow-up 😄

```

In a Cobra app, typically the main.go file is very bare. It serves one purpose: initializing Cobra.
Expand Down