[Bug] Error when running the documentation for a new package

[tmigot]

Description

I tried to add a tutorial.md file in the docs repo and the docs CI failed

Not sure if this is related but there is also this warning:

[ Info: HTMLWriter: rendering HTML pages.
┌ Warning: Unable to determine the repository root URL for the navbar link.
│ This can happen when a string is passed to the `repo` keyword of `makedocs`.
│ 
│ To remove this warning, either pass a Remotes.Remote object to `repo` to completely
│ specify the remote repository, or explicitly set the remote URL by setting `repolink`
│ via `makedocs(format = HTML(repolink = "..."), ...)`.
└ @ Documenter.HTMLWriter .julia\packages\Documenter\qoyeC\src\html\HTMLWriter.jl:732

Package Version

0.6.1

Julia Version

1.10

Reproduction steps

doc CI

Relevant log output

[ Info: SetupBuildDirectory: setting up build directory.
ERROR: LoadError: TypeError: in typeassert, expected Documenter.NavNode, got a value of type Vector{Documenter.NavNode}
Stacktrace:
  [1] (::Documenter.var"#79#80"{Nothing, Documenter.Document})(p::Vector{Pair{String, String}})
    @ Documenter .\none:0
  [2] iterate
    @ .\generator.jl:47 [inlined]
  [3] collect_to!(dest::Vector{…}, itr::Base.Generator{…}, offs::Int64, st::Int64)
    @ Base .\array.jl:892
  [4] collect_to_with_first!
    @ .\array.jl:870 [inlined]
  [5] collect(itr::Base.Generator{Vector{Any}, Documenter.var"#79#80"{Nothing, Documenter.Document}})
    @ Base .\array.jl:844
  [6] walk_navpages
    @ .julia\packages\Documenter\qoyeC\src\builder_pipeline.jl:203 [inlined]
  [7] runner(::Type{Documenter.Builder.SetupBuildDirectory}, doc::Documenter.Document)
    @ Documenter .julia\packages\Documenter\qoyeC\src\builder_pipeline.jl:133
  [8] dispatch(::Type{Documenter.Builder.DocumentPipeline}, x::Documenter.Document)
    @ Documenter.Selectors .julia\packages\Documenter\qoyeC\src\utilities\Selectors.jl:170
  [9] #86
    @ .julia\packages\Documenter\qoyeC\src\makedocs.jl:248 [inlined]
 [10] withenv(::Documenter.var"#86#88"{Documenter.Document}, ::Pair{String, Nothing}, ::Vararg{Pair{String, Nothing}})    
    @ Base .\env.jl:257
 [11] #85
    @ .julia\packages\Documenter\qoyeC\src\makedocs.jl:247 [inlined]
 [12] cd(f::Documenter.var"#85#87"{Documenter.Document}, dir::String)
    @ Base.Filesystem .\file.jl:101
 [13] #makedocs#84
    @ .julia\packages\Documenter\qoyeC\src\makedocs.jl:247 [inlined]
 [14] top-level scope
    @ .julia\dev\TimerNLPModels.jl\docs\make.jl:16
 [15] include(fname::String)
    @ Base.MainInclude .\client.jl:489
 [16] top-level scope
    @ REPL[9]:1
in expression starting at .julia\dev\TimerNLPModels.jl\docs\make.jl:16
Some type information was truncated. Use `show(err)` to see complete types.

Operating System

Windows

[abelsiqueira]

Hi @tmigot, did you add a "XX-tutorial.md" file? Do you have a link to the failing action?

[tmigot]

https://github.com/tmigot/TimerNLPModels.jl/actions/runs/9821520761/job/27117281856?pr=5

Oh, I added just a tutorial.md

[abelsiqueira]

I left a comment in your PR. Can you check if that fixes it and let us know here?

[tmigot]

Okay, problem solved. so, the issue was just that I somehow deviated from the original template (probably because I mechanicaly added a ,). Thanks!

[abelsiqueira]

Thanks for checking. I'll create an issue to improve the pages section.