feat(bookstack-api-bu8): add GoDoc documentation for all public APIs
Add package-level documentation with usage example. All exported types, functions, and variables already have proper doc comments.
This commit is contained in:
parent
5185222577
commit
453011b002
3 changed files with 20 additions and 5 deletions
15
bookstack.go
15
bookstack.go
|
|
@ -1,3 +1,18 @@
|
|||
// Package bookstack provides a Go client for the BookStack REST API.
|
||||
//
|
||||
// Create a client with NewClient and use the service fields (Books, Pages, etc.)
|
||||
// to interact with the API:
|
||||
//
|
||||
// client, err := bookstack.NewClient(bookstack.Config{
|
||||
// BaseURL: "https://docs.example.com",
|
||||
// TokenID: os.Getenv("BOOKSTACK_TOKEN_ID"),
|
||||
// TokenSecret: os.Getenv("BOOKSTACK_TOKEN_SECRET"),
|
||||
// })
|
||||
// if err != nil {
|
||||
// log.Fatal(err)
|
||||
// }
|
||||
//
|
||||
// books, err := client.Books.List(ctx, nil)
|
||||
package bookstack
|
||||
|
||||
import (
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue