Skip to content

docs: Add comprehensive Docusaurus documentation site#165

Open
teyouale wants to merge 9 commits into
IBM:mainfrom
teyouale:joel-docs/add-docusaurus-site
Open

docs: Add comprehensive Docusaurus documentation site#165
teyouale wants to merge 9 commits into
IBM:mainfrom
teyouale:joel-docs/add-docusaurus-site

Conversation

@teyouale

@teyouale teyouale commented May 13, 2026

Copy link
Copy Markdown

Eyouale Degefaw added 3 commits May 13, 2026 10:12
- Add complete documentation structure with guides, concepts, and recipes
 - Add Algolia search configuration

@CarstenLeue CarstenLeue left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I have two main points:

  • the build output should go to the gh-pages branch
  • the examples should NOT be part of the markdown files, but rather go examples pulled into the markdown at build time

Comment thread .github/workflows/deploy-docs.yml Outdated
Comment thread .github/workflows/deploy-docs.yml Outdated
Comment thread fp-go-docs/docs/recipes/data-transformation.md Outdated

<CodeCard file="processUser.go" status="tested">
{`// fp-go v2 approach
func processUser(id string) ioresult.IOResult[User] {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Should be

func processUser() readerioresult.ReaderIOResult[string, *User] {
    return function.Flow3(
        fetchUser,
        ioresult.Chain(validateUser),
        ioresult.Chain(saveUser),
    )
}

"github.com/IBM/fp-go/v2/function"
)

func processUser(id string) result.Result[User] {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The example should be

func processUser() readerresult.ReaderResult[string, User] {
    return function.Flow4(
        fetchUser,
        result.Chain(validateUser),
        result.Chain(enrichUser),
        result.Chain(saveUser),
    )
}

@teyouale teyouale requested a review from CarstenLeue June 23, 2026 16:16
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